changed global animations to handle only one CE change event per frame
[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 #include "api.h"
22
23
24 #define DEBUG_TAPE_WHEN_PLAYING                 FALSE
25
26 // tape button identifiers
27 #define TAPE_CTRL_ID_EJECT                      0
28 #define TAPE_CTRL_ID_EXTRA                      1
29 #define TAPE_CTRL_ID_STOP                       2
30 #define TAPE_CTRL_ID_PAUSE                      3
31 #define TAPE_CTRL_ID_RECORD                     4
32 #define TAPE_CTRL_ID_PLAY                       5
33 #define TAPE_CTRL_ID_INSERT_SOLUTION            6
34 #define TAPE_CTRL_ID_PLAY_SOLUTION              7
35
36 #define NUM_TAPE_BUTTONS                        8
37
38 // values for tape handling
39 #define TAPE_PAUSE_SECONDS_BEFORE_DEATH         5
40 #define TAPE_MIN_SECONDS_FOR_UNDO_BUFFER        20
41
42 // forward declaration for internal use
43 static void HandleTapeButtons(struct GadgetInfo *);
44 static void TapeStopWarpForward(void);
45 static float GetTapeLengthSecondsFloat(void);
46 static void CopyTapeToUndoBuffer(void);
47
48 static struct GadgetInfo *tape_gadget[NUM_TAPE_BUTTONS];
49 static struct TapeInfo tape_undo_buffer;
50
51
52 // ============================================================================
53 // video tape definitions
54 // ============================================================================
55
56 #define VIDEO_INFO_OFF                  (VIDEO_STATE_DATE_OFF   |       \
57                                          VIDEO_STATE_TIME_OFF   |       \
58                                          VIDEO_STATE_FRAME_OFF)
59 #define VIDEO_STATE_OFF                 (VIDEO_STATE_PLAY_OFF   |       \
60                                          VIDEO_STATE_REC_OFF    |       \
61                                          VIDEO_STATE_PAUSE_OFF  |       \
62                                          VIDEO_STATE_FFWD_OFF   |       \
63                                          VIDEO_STATE_WARP_OFF   |       \
64                                          VIDEO_STATE_WARP2_OFF  |       \
65                                          VIDEO_STATE_PBEND_OFF  |       \
66                                          VIDEO_STATE_1STEP_OFF)
67 #define VIDEO_PRESS_OFF                 (VIDEO_PRESS_PLAY_OFF   |       \
68                                          VIDEO_PRESS_REC_OFF    |       \
69                                          VIDEO_PRESS_PAUSE_OFF  |       \
70                                          VIDEO_PRESS_STOP_OFF   |       \
71                                          VIDEO_PRESS_EJECT_OFF)
72 #define VIDEO_ALL_OFF                   (VIDEO_INFO_OFF         |       \
73                                          VIDEO_STATE_OFF        |       \
74                                          VIDEO_PRESS_OFF)
75
76 #define VIDEO_INFO_ON                   (VIDEO_STATE_DATE_ON    |       \
77                                          VIDEO_STATE_TIME_ON    |       \
78                                          VIDEO_STATE_FRAME_ON)
79 #define VIDEO_STATE_ON                  (VIDEO_STATE_PLAY_ON    |       \
80                                          VIDEO_STATE_REC_ON     |       \
81                                          VIDEO_STATE_PAUSE_ON   |       \
82                                          VIDEO_STATE_FFWD_ON    |       \
83                                          VIDEO_STATE_WARP_ON    |       \
84                                          VIDEO_STATE_WARP2_ON   |       \
85                                          VIDEO_STATE_PBEND_ON   |       \
86                                          VIDEO_STATE_1STEP_ON)
87 #define VIDEO_PRESS_ON                  (VIDEO_PRESS_PLAY_ON    |       \
88                                          VIDEO_PRESS_REC_ON     |       \
89                                          VIDEO_PRESS_PAUSE_ON   |       \
90                                          VIDEO_PRESS_STOP_ON    |       \
91                                          VIDEO_PRESS_EJECT_ON)
92 #define VIDEO_ALL_ON                    (VIDEO_INFO_ON          |       \
93                                          VIDEO_STATE_ON         |       \
94                                          VIDEO_PRESS_ON)
95
96 #define VIDEO_INFO                      (VIDEO_INFO_ON | VIDEO_INFO_OFF)
97 #define VIDEO_STATE                     (VIDEO_STATE_ON | VIDEO_STATE_OFF)
98 #define VIDEO_PRESS                     (VIDEO_PRESS_ON | VIDEO_PRESS_OFF)
99 #define VIDEO_ALL                       (VIDEO_ALL_ON | VIDEO_ALL_OFF)
100
101 #define NUM_TAPE_FUNCTIONS              11
102 #define NUM_TAPE_FUNCTION_PARTS         2
103 #define NUM_TAPE_FUNCTION_STATES        2
104
105
106 // ============================================================================
107 // video display functions
108 // ============================================================================
109
110 static void DrawVideoDisplay_Graphics(unsigned int state, unsigned int value)
111 {
112   int i, j, k;
113
114   static struct
115   {
116     int graphic;
117     struct XY *pos;
118   }
119   video_pos[NUM_TAPE_FUNCTIONS][NUM_TAPE_FUNCTION_PARTS] =
120   {
121     {
122       { IMG_GFX_TAPE_LABEL_PLAY,                &tape.label.play        },
123       { IMG_GFX_TAPE_SYMBOL_PLAY,               &tape.symbol.play       },
124     },
125     {
126       { IMG_GFX_TAPE_LABEL_RECORD,              &tape.label.record      },
127       { IMG_GFX_TAPE_SYMBOL_RECORD,             &tape.symbol.record     },
128     },
129     {
130       { IMG_GFX_TAPE_LABEL_PAUSE,               &tape.label.pause       },
131       { IMG_GFX_TAPE_SYMBOL_PAUSE,              &tape.symbol.pause      },
132     },
133     {
134       { IMG_GFX_TAPE_LABEL_DATE,                &tape.label.date        },
135       { -1,                                     NULL                    },
136     },
137     {
138       { IMG_GFX_TAPE_LABEL_TIME,                &tape.label.time        },
139       { -1,                                     NULL                    },
140     },
141     {
142       // (no label for displaying optional frame)
143       { -1,                                     NULL                    },
144       { -1,                                     NULL                    },
145     },
146     {
147       { IMG_GFX_TAPE_LABEL_FAST_FORWARD,        &tape.label.fast_forward  },
148       { IMG_GFX_TAPE_SYMBOL_FAST_FORWARD,       &tape.symbol.fast_forward },
149     },
150     {
151       { IMG_GFX_TAPE_LABEL_WARP_FORWARD,        &tape.label.warp_forward  },
152       { IMG_GFX_TAPE_SYMBOL_WARP_FORWARD,       &tape.symbol.warp_forward },
153     },
154     {
155       { IMG_GFX_TAPE_LABEL_WARP_FORWARD_BLIND,  &tape.label.warp_forward_blind},
156       { IMG_GFX_TAPE_SYMBOL_WARP_FORWARD_BLIND, &tape.symbol.warp_forward_blind},
157     },
158     {
159       { IMG_GFX_TAPE_LABEL_PAUSE_BEFORE_END,    &tape.label.pause_before_end  },
160       { IMG_GFX_TAPE_SYMBOL_PAUSE_BEFORE_END,   &tape.symbol.pause_before_end },
161     },
162     {
163       { IMG_GFX_TAPE_LABEL_SINGLE_STEP,         &tape.label.single_step  },
164       { IMG_GFX_TAPE_SYMBOL_SINGLE_STEP,        &tape.symbol.single_step },
165     },
166   };
167
168   for (k = 0; k < NUM_TAPE_FUNCTION_STATES; k++)        // on or off states
169   {
170     for (i = 0; i < NUM_TAPE_FUNCTIONS; i++)            // record, play, ...
171     {
172       for (j = 0; j < NUM_TAPE_FUNCTION_PARTS; j++)     // label or symbol
173       {
174         int graphic = video_pos[i][j].graphic;
175         struct XY *pos = video_pos[i][j].pos;
176
177         if (graphic == -1 ||
178             pos->x == -1 ||
179             pos->y == -1)
180           continue;
181
182         if (state & (1 << (i * 2 + k)))
183         {
184           struct GraphicInfo *gfx_bg = &graphic_info[IMG_BACKGROUND_TAPE];
185           struct GraphicInfo *gfx = &graphic_info[graphic];
186           Bitmap *gd_bitmap;
187           int gd_x, gd_y;
188           int skip_value =
189             (j == 0 ? VIDEO_DISPLAY_SYMBOL_ONLY : VIDEO_DISPLAY_LABEL_ONLY);
190
191           if (value == skip_value)
192             continue;
193
194           if (k == 1)           // on
195           {
196             gd_bitmap = gfx->bitmap;
197             gd_x = gfx->src_x;
198             gd_y = gfx->src_y;
199           }
200           else                  // off
201           {
202             gd_bitmap = gfx_bg->bitmap;
203             gd_x = gfx_bg->src_x + pos->x;
204             gd_y = gfx_bg->src_y + pos->y;
205           }
206
207           // some tape graphics may be undefined -- only draw if defined
208           if (gd_bitmap != NULL)
209             BlitBitmap(gd_bitmap, drawto, gd_x, gd_y, gfx->width, gfx->height,
210                        VX + pos->x, VY + pos->y);
211
212           redraw_mask |= REDRAW_DOOR_2;
213         }
214       }
215     }
216   }
217 }
218
219
220 #define DATETIME_NONE                   (0)
221
222 #define DATETIME_DATE_YYYY              (1 << 0)
223 #define DATETIME_DATE_YY                (1 << 1)
224 #define DATETIME_DATE_MON               (1 << 2)
225 #define DATETIME_DATE_MM                (1 << 3)
226 #define DATETIME_DATE_DD                (1 << 4)
227
228 #define DATETIME_TIME_HH                (1 << 5)
229 #define DATETIME_TIME_MIN               (1 << 6)
230 #define DATETIME_TIME_MM                (1 << 7)
231 #define DATETIME_TIME_SS                (1 << 8)
232
233 #define DATETIME_FRAME                  (1 << 9)
234
235 #define DATETIME_XOFFSET_1              (1 << 10)
236 #define DATETIME_XOFFSET_2              (1 << 11)
237
238 #define DATETIME_DATE                   (DATETIME_DATE_YYYY     |       \
239                                          DATETIME_DATE_YY       |       \
240                                          DATETIME_DATE_MON      |       \
241                                          DATETIME_DATE_MM       |       \
242                                          DATETIME_DATE_DD)
243
244 #define DATETIME_TIME                   (DATETIME_TIME_HH       |       \
245                                          DATETIME_TIME_MIN      |       \
246                                          DATETIME_TIME_MM       |       \
247                                          DATETIME_TIME_SS)
248
249 #define MAX_DATETIME_STRING_SIZE        32
250
251 static void DrawVideoDisplay_DateTime(unsigned int state, unsigned int value)
252 {
253   int i;
254
255   static char *month_shortnames[] =
256   {
257     "JAN",
258     "FEB",
259     "MAR",
260     "APR",
261     "MAY",
262     "JUN",
263     "JUL",
264     "AUG",
265     "SEP",
266     "OCT",
267     "NOV",
268     "DEC"
269   };
270
271   static struct
272   {
273     struct TextPosInfo *pos;
274     int type;
275   }
276   datetime_info[] =
277   {
278     { &tape.text.date,          DATETIME_DATE_DD                        },
279     { &tape.text.date,          DATETIME_DATE_MON | DATETIME_XOFFSET_1  },
280     { &tape.text.date,          DATETIME_DATE_YY  | DATETIME_XOFFSET_2  },
281     { &tape.text.date_yyyy,     DATETIME_DATE_YYYY                      },
282     { &tape.text.date_yy,       DATETIME_DATE_YY                        },
283     { &tape.text.date_mon,      DATETIME_DATE_MON                       },
284     { &tape.text.date_mm,       DATETIME_DATE_MM                        },
285     { &tape.text.date_dd,       DATETIME_DATE_DD                        },
286
287     { &tape.text.time,          DATETIME_TIME_MIN                       },
288     { &tape.text.time,          DATETIME_TIME_SS  | DATETIME_XOFFSET_1  },
289     { &tape.text.time_hh,       DATETIME_TIME_HH                        },
290     { &tape.text.time_mm,       DATETIME_TIME_MM                        },
291     { &tape.text.time_ss,       DATETIME_TIME_SS                        },
292
293     { &tape.text.frame,         DATETIME_FRAME                          },
294
295     { NULL,                     DATETIME_NONE                           },
296   };
297
298   for (i = 0; datetime_info[i].pos != NULL; i++)
299   {
300     struct TextPosInfo *pos = datetime_info[i].pos;
301     int type = datetime_info[i].type;
302     int xpos, ypos;
303
304     if (pos->x == -1 &&
305         pos->y == -1)
306       continue;
307
308     xpos = VX + pos->x + (type & DATETIME_XOFFSET_1 ? pos->xoffset  :
309                           type & DATETIME_XOFFSET_2 ? pos->xoffset2 : 0);
310     ypos = VY + pos->y;
311
312     if ((type & DATETIME_DATE) && (state & VIDEO_STATE_DATE_ON))
313     {
314       char s[MAX_DATETIME_STRING_SIZE];
315       int year2 = value / 10000;
316       int year4 = (year2 < 70 ? 2000 + year2 : 1900 + year2);
317       int month_index_raw = (value / 100) % 100;
318       int month_index = month_index_raw % 12;   // prevent invalid index
319       int month = month_index + 1;
320       int day = value % 100;
321
322       strcpy(s, (type & DATETIME_DATE_YYYY ? int2str(year4, 4) :
323                  type & DATETIME_DATE_YY   ? int2str(year2, 2) :
324                  type & DATETIME_DATE_MON  ? month_shortnames[month_index] :
325                  type & DATETIME_DATE_MM   ? int2str(month, 2) :
326                  type & DATETIME_DATE_DD   ? int2str(day, 2) : ""));
327
328       DrawText(xpos, ypos, s, pos->font);
329     }
330     else if ((type & DATETIME_TIME) && (state & VIDEO_STATE_TIME_ON))
331     {
332       char s[MAX_DATETIME_STRING_SIZE];
333       int hh = (value / 3600) % 100;
334       int min = value / 60;
335       int mm = (value / 60) % 60;
336       int ss = value % 60;
337
338       strcpy(s, (type & DATETIME_TIME_HH  ? int2str(hh, 2) :
339                  type & DATETIME_TIME_MIN ? int2str(min, 2) :
340                  type & DATETIME_TIME_MM  ? int2str(mm, 2) :
341                  type & DATETIME_TIME_SS  ? int2str(ss, 2) : ""));
342
343       DrawText(xpos, ypos, s, pos->font);
344     }
345     else if ((type & DATETIME_FRAME) && (state & VIDEO_STATE_FRAME_ON))
346     {
347       DrawText(xpos, ypos, int2str(value, pos->size), pos->font);
348     }
349   }
350 }
351
352 void DrawVideoDisplay(unsigned int state, unsigned int value)
353 {
354   DrawVideoDisplay_Graphics(state, value);
355   DrawVideoDisplay_DateTime(state, value);
356 }
357
358 static void DrawVideoDisplayLabel(unsigned int state)
359 {
360   DrawVideoDisplay(state, VIDEO_DISPLAY_LABEL_ONLY);
361 }
362
363 static void DrawVideoDisplaySymbol(unsigned int state)
364 {
365   DrawVideoDisplay(state, VIDEO_DISPLAY_SYMBOL_ONLY);
366 }
367
368 static void DrawVideoDisplayCurrentState(void)
369 {
370   int state = 0;
371
372   DrawVideoDisplay(VIDEO_STATE_OFF, 0);
373
374   if (tape.pausing)
375     state |= VIDEO_STATE_PAUSE_ON;
376
377   if (tape.recording)
378   {
379     state |= VIDEO_STATE_REC_ON;
380
381     if (tape.single_step)
382       state |= VIDEO_STATE_1STEP_ON;
383   }
384   else if (tape.playing)
385   {
386     state |= VIDEO_STATE_PLAY_ON;
387
388     if (!tape.pausing)
389     {
390       if (tape.deactivate_display)
391         state |= VIDEO_STATE_WARP2_ON;
392       else if (tape.warp_forward)
393         state |= VIDEO_STATE_WARP_ON;
394       else if (tape.fast_forward)
395         state |= VIDEO_STATE_FFWD_ON;
396
397       if (tape.pause_before_end)
398         state |= VIDEO_STATE_PBEND_ON;
399     }
400   }
401
402   // draw labels and symbols separately to prevent labels overlapping symbols
403   DrawVideoDisplayLabel(state);
404   DrawVideoDisplaySymbol(state);
405 }
406
407 void DrawCompleteVideoDisplay(void)
408 {
409   struct GraphicInfo *g_tape = &graphic_info[IMG_BACKGROUND_TAPE];
410
411   // draw tape background
412   BlitBitmap(g_tape->bitmap, drawto, g_tape->src_x, g_tape->src_y,
413              gfx.vxsize, gfx.vysize, gfx.vx, gfx.vy);
414
415   // draw tape buttons (forced)
416   RedrawOrRemapTapeButtons();
417
418   DrawVideoDisplay(VIDEO_ALL_OFF, 0);
419
420   if (tape.recording)
421   {
422     DrawVideoDisplay(VIDEO_STATE_REC_ON, 0);
423     DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
424     DrawVideoDisplay(VIDEO_STATE_TIME_ON, tape.length_seconds);
425     DrawVideoDisplay(VIDEO_STATE_FRAME_ON, tape.length_frames);
426
427     if (tape.pausing)
428       DrawVideoDisplay(VIDEO_STATE_PAUSE_ON, 0);
429   }
430   else if (tape.playing)
431   {
432     DrawVideoDisplay(VIDEO_STATE_PLAY_ON, 0);
433     DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
434     DrawVideoDisplay(VIDEO_STATE_TIME_ON, 0);
435     DrawVideoDisplay(VIDEO_STATE_FRAME_ON, 0);
436
437     if (tape.pausing)
438       DrawVideoDisplay(VIDEO_STATE_PAUSE_ON, 0);
439   }
440   else if (tape.date && tape.length)
441   {
442     DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
443     DrawVideoDisplay(VIDEO_STATE_TIME_ON, tape.length_seconds);
444     DrawVideoDisplay(VIDEO_STATE_FRAME_ON, tape.length_frames);
445   }
446
447   BlitBitmap(drawto, bitmap_db_door_2, gfx.vx, gfx.vy, gfx.vxsize, gfx.vysize,
448              0, 0);
449 }
450
451 void TapeDeactivateDisplayOn(void)
452 {
453   SetDrawDeactivationMask(REDRAW_FIELD);
454   audio.sound_deactivated = TRUE;
455 }
456
457 void TapeDeactivateDisplayOff(boolean redraw_display)
458 {
459   SetDrawDeactivationMask(REDRAW_NONE);
460   audio.sound_deactivated = FALSE;
461
462   if (redraw_display)
463   {
464     RedrawPlayfield();
465
466     UpdateGameDoorValues();
467     DrawGameDoorValues();
468   }
469 }
470
471
472 // ============================================================================
473 // tape logging functions
474 // ============================================================================
475
476 struct AutoPlayInfo
477 {
478   LevelDirTree *leveldir;
479   boolean all_levelsets;
480   int last_level_nr;
481   int level_nr;
482   int num_levels_played;
483   int num_levels_solved;
484   int num_tapes_patched;
485   int num_tape_missing;
486   boolean level_failed[MAX_TAPES_PER_SET];
487   char *tape_filename;
488 };
489
490 static char tape_patch_info[MAX_OUTPUT_LINESIZE];
491
492 static void PrintTapeReplayHeader(struct AutoPlayInfo *autoplay)
493 {
494   PrintLine("=", 79);
495
496   if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
497     Print("Automatically fixing level tapes\n");
498   else if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
499     Print("Automatically uploading level tapes\n");
500   else
501     Print("Automatically playing level tapes\n");
502
503   PrintLine("-", 79);
504   Print("Level series identifier: '%s'\n", autoplay->leveldir->identifier);
505   Print("Level series name:       '%s'\n", autoplay->leveldir->name);
506   Print("Level series author:     '%s'\n", autoplay->leveldir->author);
507   Print("Number of levels:        %d\n",   autoplay->leveldir->levels);
508   PrintLine("=", 79);
509   Print("\n");
510
511   DrawInitTextItem(autoplay->leveldir->name);
512 }
513
514 static void PrintTapeReplayProgress(boolean replay_finished)
515 {
516   static unsigned int counter_last = -1;
517   unsigned int counter = Counter();
518   unsigned int counter_seconds  = counter / 1000;
519
520   if (!replay_finished)
521   {
522     unsigned int counter_delay = 50;
523
524     if (counter > counter_last + counter_delay)
525     {
526       PrintNoLog("\r");
527       PrintNoLog("Tape %03d %s[%02d:%02d]: [%02d:%02d] - playing tape ... ",
528                  level_nr,  tape_patch_info,
529                  tape.length_seconds / 60, tape.length_seconds % 60,
530                  TapeTime / 60, TapeTime % 60);
531
532       counter_last = counter;
533     }
534   }
535   else
536   {
537     float tape_length_seconds = GetTapeLengthSecondsFloat();
538
539     PrintNoLog("\r");
540     Print("Tape %03d %s[%02d:%02d]: (%02d:%02d.%03d / %.2f %%) - %s.\n",
541           level_nr, tape_patch_info,
542           tape.length_seconds / 60, tape.length_seconds % 60,
543           counter_seconds / 60, counter_seconds % 60, counter % 1000,
544           (float)counter / tape_length_seconds / 10,
545           tape.auto_play_level_fixed ? "solved and fixed" :
546           tape.auto_play_level_solved ? "solved" :
547           tape.auto_play_level_not_fixable ? "NOT SOLVED, NOT FIXED" :
548           "NOT SOLVED");
549
550     counter_last = -1;
551   }
552 }
553
554 static void PrintTapeReplaySummary(struct AutoPlayInfo *autoplay)
555 {
556   char *autoplay_status =
557     (autoplay->num_levels_played == autoplay->num_levels_solved &&
558      autoplay->num_levels_played > 0 ? " OK " : "WARN");
559   int autoplay_percent =
560     (autoplay->num_levels_played ?
561      autoplay->num_levels_solved * 100 / autoplay->num_levels_played : 0);
562   int i;
563
564   Print("\n");
565   PrintLine("=", 79);
566   Print("Number of levels played: %d\n", autoplay->num_levels_played);
567   Print("Number of levels solved: %d (%d%%)\n", autoplay->num_levels_solved,
568         (autoplay->num_levels_played ?
569          autoplay->num_levels_solved * 100 / autoplay->num_levels_played : 0));
570   if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
571     Print("Number of tapes fixed: %d\n", autoplay->num_tapes_patched);
572   PrintLine("-", 79);
573   Print("Summary (for automatic parsing by scripts):\n");
574
575   if (autoplay->tape_filename)
576   {
577     Print("TAPEFILE [%s] '%s', %d, %d, %d",
578           autoplay_status,
579           autoplay->leveldir->identifier,
580           autoplay->last_level_nr,
581           game.score_final,
582           game.score_time_final);
583   }
584   else
585   {
586     Print("LEVELDIR [%s] '%s', SOLVED %d/%d (%d%%)",
587           autoplay_status,
588           autoplay->leveldir->identifier,
589           autoplay->num_levels_solved,
590           autoplay->num_levels_played,
591           autoplay_percent);
592
593     if (autoplay->num_levels_played != autoplay->num_levels_solved)
594     {
595       Print(", FAILED:");
596       for (i = 0; i < MAX_TAPES_PER_SET; i++)
597         if (autoplay->level_failed[i])
598           Print(" %03d", i);
599     }
600   }
601
602   Print("\n");
603   PrintLine("=", 79);
604 }
605
606 static FILE *tape_log_file;
607
608 static void OpenTapeLogfile(void)
609 {
610   if (!(tape_log_file = fopen(options.tape_log_filename, MODE_WRITE)))
611     Warn("cannot write tape logfile '%s'", options.tape_log_filename);
612 }
613
614 static void WriteTapeLogfile(byte action[MAX_TAPE_ACTIONS])
615 {
616   int i;
617
618   for (i = 0; i < MAX_TAPE_ACTIONS; i++)
619     putFile8Bit(tape_log_file, action[i]);
620 }
621
622 static void CloseTapeLogfile(void)
623 {
624   fclose(tape_log_file);
625 }
626
627
628 // ============================================================================
629 // tape control functions
630 // ============================================================================
631
632 void TapeSetDateFromEpochSeconds(time_t epoch_seconds)
633 {
634   struct tm *lt = localtime(&epoch_seconds);
635
636   tape.date = 10000 * (lt->tm_year % 100) + 100 * lt->tm_mon + lt->tm_mday;
637 }
638
639 void TapeSetDateFromNow(void)
640 {
641   TapeSetDateFromEpochSeconds(time(NULL));
642 }
643
644 void TapeErase(void)
645 {
646   int i;
647
648   CopyTapeToUndoBuffer();
649
650   tape.counter = 0;
651   tape.length = 0;
652   tape.length_frames = 0;
653   tape.length_seconds = 0;
654
655   tape.score_tape_basename[0] = '\0';
656
657   if (leveldir_current)
658   {
659     strncpy(tape.level_identifier, leveldir_current->identifier,
660             MAX_FILENAME_LEN);
661     tape.level_identifier[MAX_FILENAME_LEN] = '\0';
662   }
663
664   tape.level_nr = level_nr;
665   tape.pos[tape.counter].delay = 0;
666   tape.changed = TRUE;
667   tape.solved = FALSE;
668
669   tape.random_seed = InitRND(level.random_seed);
670
671   tape.file_version = FILE_VERSION_ACTUAL;
672   tape.game_version = GAME_VERSION_ACTUAL;
673   tape.engine_version = level.game_version;
674
675   tape.property_bits = TAPE_PROPERTY_NONE;
676
677   TapeSetDateFromNow();
678
679   for (i = 0; i < MAX_PLAYERS; i++)
680     tape.player_participates[i] = FALSE;
681
682   tape.centered_player_nr_next = -1;
683   tape.set_centered_player = FALSE;
684
685   // set flags for game actions to default values (may be overwritten later)
686   tape.use_key_actions = TRUE;
687   tape.use_mouse_actions = FALSE;
688 }
689
690 static void TapeRewind(void)
691 {
692   tape.counter = 0;
693   tape.delay_played = 0;
694   tape.pause_before_end = FALSE;
695   tape.recording = FALSE;
696   tape.playing = FALSE;
697   tape.fast_forward = FALSE;
698   tape.warp_forward = FALSE;
699   tape.deactivate_display = FALSE;
700   tape.auto_play = (global.autoplay_leveldir != NULL);
701   tape.auto_play_level_solved = FALSE;
702   tape.auto_play_level_fixed = FALSE;
703   tape.auto_play_level_not_fixable = FALSE;
704   tape.quick_resume = FALSE;
705   tape.single_step = FALSE;
706
707   tape.centered_player_nr_next = -1;
708   tape.set_centered_player = FALSE;
709
710   InitRND(tape.random_seed);
711 }
712
713 static void TapeSetRandomSeed(int random_seed)
714 {
715   tape.random_seed = InitRND(random_seed);
716 }
717
718 void TapeStartRecording(int random_seed)
719 {
720   if (!TAPE_IS_STOPPED(tape))
721     TapeStop();
722
723   TapeErase();
724   TapeRewind();
725   TapeSetRandomSeed(random_seed);
726
727   tape.recording = TRUE;
728
729   DrawVideoDisplay(VIDEO_STATE_REC_ON, 0);
730   DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
731   DrawVideoDisplay(VIDEO_STATE_TIME_ON, 0);
732   DrawVideoDisplay(VIDEO_STATE_FRAME_ON, 0);
733
734   MapTapeWarpButton();
735
736   SetDrawDeactivationMask(REDRAW_NONE);
737   audio.sound_deactivated = FALSE;
738
739   // required here to update video display if tape door is closed
740   if (GetDoorState() & DOOR_CLOSE_2)
741     OpenDoor(GetDoorState() | DOOR_NO_DELAY | DOOR_FORCE_REDRAW);
742 }
743
744 static void TapeStartGameRecording(void)
745 {
746   StartGameActions(network.enabled, TRUE, level.random_seed);
747 }
748
749 static void TapeAppendRecording(void)
750 {
751   if (!tape.playing || !tape.pausing)
752     return;
753
754   // stop playing
755   tape.playing = FALSE;
756   tape.fast_forward = FALSE;
757   tape.warp_forward = FALSE;
758   tape.pause_before_end = FALSE;
759   tape.deactivate_display = FALSE;
760
761   // start recording
762   tape.recording = TRUE;
763   tape.changed = TRUE;
764   tape.solved = FALSE;
765
766   // set current delay (for last played move)
767   tape.pos[tape.counter].delay = tape.delay_played;
768
769   tape.property_bits |= TAPE_PROPERTY_REPLAYED;
770
771   // set current date
772   TapeSetDateFromNow();
773
774   DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
775   DrawVideoDisplay(VIDEO_STATE_PLAY_OFF | VIDEO_STATE_REC_ON, 0);
776
777   UpdateAndDisplayGameControlValues();
778 }
779
780 void TapeHaltRecording(void)
781 {
782   // only advance tape counter if any input events have been recorded
783   if (tape.pos[tape.counter].delay > 0)
784     tape.counter++;
785
786   // initialize delay for next tape entry (to be able to continue recording)
787   if (tape.counter < MAX_TAPE_LEN)
788     tape.pos[tape.counter].delay = 0;
789
790   tape.length = tape.counter;
791   tape.length_frames = GetTapeLengthFrames();
792   tape.length_seconds = GetTapeLengthSeconds();
793 }
794
795 void TapeStopRecording(void)
796 {
797   if (tape.recording)
798     TapeHaltRecording();
799
800   tape.recording = FALSE;
801   tape.pausing = FALSE;
802
803   DrawVideoDisplay(VIDEO_STATE_REC_OFF, 0);
804   MapTapeEjectButton();
805 }
806
807 boolean TapeAddAction(byte action[MAX_TAPE_ACTIONS])
808 {
809   int i;
810
811   if (tape.pos[tape.counter].delay > 0)         // already stored action
812   {
813     boolean changed_events = FALSE;
814
815     for (i = 0; i < MAX_TAPE_ACTIONS; i++)
816       if (tape.pos[tape.counter].action[i] != action[i])
817         changed_events = TRUE;
818
819     if (changed_events || tape.pos[tape.counter].delay >= 255)
820     {
821       if (tape.counter >= MAX_TAPE_LEN - 1)
822         return FALSE;
823
824       tape.counter++;
825       tape.pos[tape.counter].delay = 0;
826     }
827     else
828       tape.pos[tape.counter].delay++;
829   }
830
831   if (tape.pos[tape.counter].delay == 0)        // store new action
832   {
833     for (i = 0; i < MAX_TAPE_ACTIONS; i++)
834       tape.pos[tape.counter].action[i] = action[i];
835
836     tape.pos[tape.counter].delay++;
837   }
838
839   tape.changed = TRUE;
840
841   return TRUE;
842 }
843
844 void TapeRecordAction(byte action_raw[MAX_TAPE_ACTIONS])
845 {
846   byte action[MAX_TAPE_ACTIONS];
847   int i;
848
849   if (!tape.recording)          // (record action even when tape is paused)
850     return;
851
852   for (i = 0; i < MAX_TAPE_ACTIONS; i++)
853     action[i] = action_raw[i];
854
855   if (tape.use_key_actions && tape.set_centered_player)
856   {
857     for (i = 0; i < MAX_PLAYERS; i++)
858       if (tape.centered_player_nr_next == i ||
859           tape.centered_player_nr_next == -1)
860         action[i] |= KEY_SET_FOCUS;
861
862     tape.set_centered_player = FALSE;
863   }
864
865   if (GameFrameDelay != GAME_FRAME_DELAY)
866     tape.property_bits |= TAPE_PROPERTY_GAME_SPEED;
867
868   if (setup.small_game_graphics || SCR_FIELDX >= 2 * SCR_FIELDX_DEFAULT)
869     tape.property_bits |= TAPE_PROPERTY_SMALL_GRAPHICS;
870
871   if (!TapeAddAction(action))
872     TapeStopRecording();
873 }
874
875 void TapeTogglePause(boolean toggle_mode)
876 {
877   if (tape.playing && tape.pausing && (toggle_mode & TAPE_TOGGLE_PLAY_PAUSE))
878   {
879     // continue playing in normal mode
880     tape.fast_forward = FALSE;
881     tape.warp_forward = FALSE;
882     tape.deactivate_display = FALSE;
883
884     tape.pause_before_end = FALSE;
885   }
886
887   tape.pausing = !tape.pausing;
888
889   if (tape.single_step && (toggle_mode & TAPE_TOGGLE_MANUAL))
890     tape.single_step = FALSE;
891
892   if (tape.single_step)
893     tape.property_bits |= TAPE_PROPERTY_SINGLE_STEP;
894
895   if (tape.pausing)
896     tape.property_bits |= TAPE_PROPERTY_PAUSE_MODE;
897
898   DrawVideoDisplayCurrentState();
899
900   if (tape.deactivate_display)
901   {
902     if (tape.pausing)
903       TapeDeactivateDisplayOff(game_status == GAME_MODE_PLAYING);
904     else
905       TapeDeactivateDisplayOn();
906   }
907
908   if (tape.quick_resume)
909   {
910     tape.quick_resume = FALSE;
911
912     TapeStopWarpForward();
913     TapeAppendRecording();
914
915     if (!CheckEngineSnapshotSingle())
916       SaveEngineSnapshotSingle();
917
918     // restart step/move snapshots after quick loading tape
919     SaveEngineSnapshotToListInitial();
920
921     // do not map undo/redo buttons after quick loading tape
922     return;
923   }
924
925   if (game_status == GAME_MODE_PLAYING)
926   {
927     if (setup.show_load_save_buttons &&
928         setup.show_undo_redo_buttons &&
929         CheckEngineSnapshotList())
930     {
931       if (tape.pausing)
932         MapUndoRedoButtons();
933       else if (!tape.single_step)
934         MapLoadSaveButtons();
935     }
936
937     ModifyPauseButtons();
938   }
939
940   // stop tape when leaving auto-pause after completely replaying tape
941   if (tape.playing && !tape.pausing && tape.counter >= tape.length)
942     TapeStop();
943 }
944
945 void TapeStartPlaying(void)
946 {
947   if (TAPE_IS_EMPTY(tape))
948     return;
949
950   if (!TAPE_IS_STOPPED(tape))
951     TapeStop();
952
953   TapeRewind();
954
955   tape.playing = TRUE;
956
957   DrawVideoDisplay(VIDEO_STATE_PLAY_ON, 0);
958   DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
959   DrawVideoDisplay(VIDEO_STATE_TIME_ON, 0);
960   DrawVideoDisplay(VIDEO_STATE_FRAME_ON, 0);
961
962   MapTapeWarpButton();
963
964   SetDrawDeactivationMask(REDRAW_NONE);
965   audio.sound_deactivated = FALSE;
966 }
967
968 static void TapeStartGamePlaying(void)
969 {
970   TapeStartPlaying();
971
972   InitGame();
973 }
974
975 void TapeStopPlaying(void)
976 {
977   tape.playing = FALSE;
978   tape.pausing = FALSE;
979
980   if (tape.warp_forward)
981     TapeStopWarpForward();
982
983   DrawVideoDisplay(VIDEO_STATE_PLAY_OFF, 0);
984   MapTapeEjectButton();
985 }
986
987 byte *TapePlayAction(void)
988 {
989   int update_delay = FRAMES_PER_SECOND / 2;
990   boolean update_video_display = (FrameCounter % update_delay == 0);
991   boolean update_draw_label_on = ((FrameCounter / update_delay) % 2 == 1);
992   static byte action[MAX_TAPE_ACTIONS];
993   int i;
994
995   if (!tape.playing || tape.pausing)
996     return NULL;
997
998   if (tape.pause_before_end)  // stop some seconds before end of tape
999   {
1000     if (TapeTime > (int)tape.length_seconds - TAPE_PAUSE_SECONDS_BEFORE_DEATH)
1001     {
1002       TapeStopWarpForward();
1003       TapeTogglePause(TAPE_TOGGLE_MANUAL);
1004
1005       if (setup.autorecord_after_replay)
1006         TapeAppendRecording();
1007
1008       return NULL;
1009     }
1010   }
1011
1012   if (tape.counter >= tape.length)      // end of tape reached
1013   {
1014     if (!tape.auto_play)
1015     {
1016       TapeStopWarpForward();
1017       TapeTogglePause(TAPE_TOGGLE_MANUAL);
1018
1019       if (setup.autorecord_after_replay)
1020         TapeAppendRecording();
1021     }
1022     else
1023     {
1024       TapeStop();
1025     }
1026
1027     return NULL;
1028   }
1029
1030   if (update_video_display && !tape.deactivate_display)
1031   {
1032     int state = 0;
1033
1034     if (tape.warp_forward)
1035       state |= VIDEO_STATE_WARP(update_draw_label_on);
1036     else if (tape.fast_forward)
1037       state |= VIDEO_STATE_FFWD(update_draw_label_on);
1038
1039     if (tape.pause_before_end)
1040       state |= VIDEO_STATE_PBEND(update_draw_label_on);
1041
1042     // draw labels and symbols separately to prevent labels overlapping symbols
1043     DrawVideoDisplayLabel(state);
1044     DrawVideoDisplaySymbol(state);
1045   }
1046
1047   for (i = 0; i < MAX_TAPE_ACTIONS; i++)
1048     action[i] = tape.pos[tape.counter].action[i];
1049
1050 #if DEBUG_TAPE_WHEN_PLAYING
1051   DebugContinued("", "%05d", FrameCounter);
1052   for (i = 0; i < MAX_TAPE_ACTIONS; i++)
1053     DebugContinued("", "   %08x", action[i]);
1054   DebugContinued("tape:play", "\n");
1055 #endif
1056
1057   tape.set_centered_player = FALSE;
1058   tape.centered_player_nr_next = -999;
1059
1060   if (tape.use_key_actions)
1061   {
1062     for (i = 0; i < MAX_PLAYERS; i++)
1063     {
1064       if (action[i] & KEY_SET_FOCUS)
1065       {
1066         tape.set_centered_player = TRUE;
1067         tape.centered_player_nr_next =
1068           (tape.centered_player_nr_next == -999 ? i : -1);
1069       }
1070
1071       action[i] &= ~KEY_SET_FOCUS;
1072     }
1073   }
1074
1075   tape.delay_played++;
1076   if (tape.delay_played >= tape.pos[tape.counter].delay)
1077   {
1078     tape.counter++;
1079     tape.delay_played = 0;
1080   }
1081
1082   if (tape.auto_play)
1083     PrintTapeReplayProgress(FALSE);
1084
1085   if (options.tape_log_filename != NULL)
1086     WriteTapeLogfile(action);
1087
1088   return action;
1089 }
1090
1091 void TapeStop(void)
1092 {
1093   if (tape.pausing)
1094     TapeTogglePause(TAPE_TOGGLE_MANUAL);
1095
1096   TapeStopRecording();
1097   TapeStopPlaying();
1098
1099   DrawVideoDisplay(VIDEO_STATE_OFF, 0);
1100
1101   if (tape.date && tape.length)
1102   {
1103     DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
1104     DrawVideoDisplay(VIDEO_STATE_TIME_ON, tape.length_seconds);
1105     DrawVideoDisplay(VIDEO_STATE_FRAME_ON, tape.length_frames);
1106   }
1107 }
1108
1109 static void TapeStopGameOrTape(boolean stop_game)
1110 {
1111   if (score_info_tape_play || (!tape.playing && stop_game))
1112     RequestQuitGame(FALSE);
1113   else
1114     TapeStop();
1115 }
1116
1117 void TapeStopGame(void)
1118 {
1119   if (game_status == GAME_MODE_MAIN)
1120     return;
1121
1122   TapeStopGameOrTape(TRUE);
1123 }
1124
1125 void TapeStopTape(void)
1126 {
1127   TapeStopGameOrTape(FALSE);
1128 }
1129
1130 unsigned int GetTapeLengthFrames(void)
1131 {
1132   unsigned int tape_length_frames = 0;
1133   int i;
1134
1135   if (TAPE_IS_EMPTY(tape))
1136     return 0;
1137
1138   for (i = 0; i < tape.length; i++)
1139     tape_length_frames += tape.pos[i].delay;
1140
1141   return tape_length_frames;
1142 }
1143
1144 unsigned int GetTapeLengthSeconds(void)
1145 {
1146   return (GetTapeLengthFrames() * GAME_FRAME_DELAY / 1000);
1147 }
1148
1149 static float GetTapeLengthSecondsFloat(void)
1150 {
1151   return ((float)GetTapeLengthFrames() * GAME_FRAME_DELAY / 1000);
1152 }
1153
1154 static void TapeStartWarpForward(int mode)
1155 {
1156   tape.fast_forward = (mode & AUTOPLAY_FFWD);
1157   tape.warp_forward = (mode & AUTOPLAY_WARP);
1158   tape.deactivate_display = (mode & AUTOPLAY_WARP_NO_DISPLAY);
1159
1160   tape.pausing = FALSE;
1161
1162   if (tape.deactivate_display)
1163     TapeDeactivateDisplayOn();
1164
1165   DrawVideoDisplayCurrentState();
1166 }
1167
1168 static void TapeStopWarpForward(void)
1169 {
1170   tape.fast_forward = FALSE;
1171   tape.warp_forward = FALSE;
1172   tape.deactivate_display = FALSE;
1173
1174   tape.pause_before_end = FALSE;
1175
1176   TapeDeactivateDisplayOff(game_status == GAME_MODE_PLAYING);
1177
1178   DrawVideoDisplayCurrentState();
1179 }
1180
1181 static void TapeSingleStep(void)
1182 {
1183   if (network.enabled)
1184     return;
1185
1186   if (!tape.pausing)
1187     TapeTogglePause(TAPE_TOGGLE_MANUAL);
1188
1189   tape.single_step = !tape.single_step;
1190
1191   DrawVideoDisplay(VIDEO_STATE_1STEP(tape.single_step), 0);
1192 }
1193
1194 void TapeQuickSave(void)
1195 {
1196   if (game_status != GAME_MODE_PLAYING)
1197   {
1198     Request("No game that could be saved!", REQ_CONFIRM);
1199
1200     return;
1201   }
1202
1203   if (!tape.recording)
1204   {
1205     Request("No recording that could be saved!", REQ_CONFIRM);
1206
1207     return;
1208   }
1209
1210   TapeHaltRecording();          // prepare tape for saving on-the-fly
1211
1212   if (TAPE_IS_EMPTY(tape))
1213   {
1214     Request("No tape that could be saved!", REQ_CONFIRM);
1215
1216     return;
1217   }
1218
1219   tape.property_bits |= TAPE_PROPERTY_SNAPSHOT;
1220
1221   if (SaveTapeChecked(tape.level_nr))
1222     SaveEngineSnapshotSingle();
1223 }
1224
1225 void TapeQuickLoad(void)
1226 {
1227   char *filename = getTapeFilename(level_nr);
1228
1229   if (!fileExists(filename))
1230   {
1231     Request("No tape for this level!", REQ_CONFIRM);
1232
1233     return;
1234   }
1235
1236   if (tape.recording && !Request("Stop recording and load tape?",
1237                                  REQ_ASK | REQ_STAY_CLOSED))
1238   {
1239     OpenDoor(DOOR_OPEN_1 | DOOR_COPY_BACK);
1240
1241     return;
1242   }
1243
1244   if (game_status != GAME_MODE_PLAYING && game_status != GAME_MODE_MAIN)
1245     return;
1246
1247   if (CheckEngineSnapshotSingle())
1248   {
1249     TapeStartGamePlaying();
1250
1251     LoadEngineSnapshotSingle();
1252
1253     DrawCompleteVideoDisplay();
1254
1255     tape.playing = TRUE;
1256     tape.pausing = TRUE;
1257
1258     TapeStopWarpForward();
1259     TapeAppendRecording();
1260
1261     // restart step/move snapshots after quick loading tape
1262     SaveEngineSnapshotToListInitial();
1263
1264     if (FrameCounter > 0)
1265       return;
1266   }
1267
1268   TapeStop();
1269   TapeErase();
1270
1271   LoadTape(level_nr);
1272
1273   if (!TAPE_IS_EMPTY(tape))
1274   {
1275     TapeStartGamePlaying();
1276     TapeStartWarpForward(AUTOPLAY_MODE_WARP_NO_DISPLAY);
1277
1278     tape.quick_resume = TRUE;
1279     tape.property_bits |= TAPE_PROPERTY_SNAPSHOT;
1280   }
1281   else  // this should not happen (basically checked above)
1282   {
1283     int reopen_door = (game_status == GAME_MODE_PLAYING ? REQ_REOPEN : 0);
1284
1285     Request("No tape for this level!", REQ_CONFIRM | reopen_door);
1286   }
1287 }
1288
1289 static boolean checkRestartGame(char *message)
1290 {
1291   if (game_status == GAME_MODE_MAIN)
1292     return TRUE;
1293
1294   if (!hasStartedNetworkGame())
1295     return FALSE;
1296
1297   if (level_editor_test_game)
1298     return TRUE;
1299
1300   if (game.all_players_gone)
1301     return TRUE;
1302
1303   if (!setup.ask_on_quit_game)
1304     return TRUE;
1305
1306   if (Request(message, REQ_ASK | REQ_STAY_CLOSED))
1307     return TRUE;
1308
1309   OpenDoor(DOOR_OPEN_1 | DOOR_COPY_BACK);
1310
1311   return FALSE;
1312 }
1313
1314 void TapeRestartGame(void)
1315 {
1316   if (score_info_tape_play)
1317   {
1318     TapeStartGamePlaying();
1319
1320     return;
1321   }
1322
1323   if (!checkRestartGame("Restart game?"))
1324     return;
1325
1326   StartGameActions(network.enabled, setup.autorecord, level.random_seed);
1327 }
1328
1329 void TapeReplayAndPauseBeforeEnd(void)
1330 {
1331   if (score_info_tape_play)
1332     return;
1333
1334   if (TAPE_IS_EMPTY(tape) && !tape.recording)
1335   {
1336     Request("No tape for this level!", REQ_CONFIRM);
1337
1338     return;
1339   }
1340
1341   if (!checkRestartGame("Replay game and pause before end?"))
1342     return;
1343
1344   TapeStop();
1345   TapeStartGamePlaying();
1346   TapeStartWarpForward(AUTOPLAY_MODE_WARP_NO_DISPLAY);
1347
1348   tape.pause_before_end = TRUE;
1349   tape.quick_resume = TRUE;
1350 }
1351
1352 boolean hasSolutionTape(void)
1353 {
1354   boolean tape_file_exists = fileExists(getSolutionTapeFilename(level_nr));
1355   boolean level_has_tape = (level.game_engine_type == GAME_ENGINE_TYPE_SP &&
1356                             level.native_sp_level->demo.is_available);
1357
1358   return (tape_file_exists || level_has_tape);
1359 }
1360
1361 boolean InsertSolutionTape(void)
1362 {
1363   if (!hasSolutionTape())
1364   {
1365     Request("No solution tape for this level!", REQ_CONFIRM);
1366
1367     return FALSE;
1368   }
1369
1370   if (!TAPE_IS_STOPPED(tape))
1371     TapeStop();
1372
1373   // if tape recorder already contains a tape, remove it without asking
1374   TapeErase();
1375
1376   LoadSolutionTape(level_nr);
1377
1378   DrawCompleteVideoDisplay();
1379
1380   if (TAPE_IS_EMPTY(tape))
1381   {
1382     Request("Loading solution tape for this level failed!", REQ_CONFIRM);
1383
1384     return FALSE;
1385   }
1386
1387   return TRUE;
1388 }
1389
1390 boolean PlaySolutionTape(void)
1391 {
1392   if (!InsertSolutionTape())
1393     return FALSE;
1394
1395   TapeStartGamePlaying();
1396
1397   return TRUE;
1398 }
1399
1400 static boolean PlayScoreTape_WaitForDownload(void)
1401 {
1402   DelayCounter download_delay = { 10000 };
1403
1404   ResetDelayCounter(&download_delay);
1405
1406   // wait for score tape to be successfully downloaded (and fail on timeout)
1407   while (!server_scores.tape_downloaded)
1408   {
1409     if (DelayReached(&download_delay))
1410       return FALSE;
1411
1412     UPDATE_BUSY_STATE_NOT_LOADING();
1413
1414     Delay(20);
1415   }
1416
1417   return TRUE;
1418 }
1419
1420 boolean PlayScoreTape(int entry_nr)
1421 {
1422   struct ScoreEntry *entry = &scores.entry[entry_nr];
1423   char *tape_filename =
1424     (entry->id == -1 ?
1425      getScoreTapeFilename(entry->tape_basename, level_nr) :
1426      getScoreCacheTapeFilename(entry->tape_basename, level_nr));
1427   boolean download_tape = (!fileExists(tape_filename));
1428
1429   if (download_tape && entry->id == -1)
1430   {
1431     FadeSkipNextFadeIn();
1432
1433     Request("Cannot find score tape!", REQ_CONFIRM);
1434
1435     return FALSE;
1436   }
1437
1438   server_scores.tape_downloaded = FALSE;
1439
1440   if (download_tape)
1441     ApiGetScoreTapeAsThread(level_nr, entry->id, entry->tape_basename);
1442
1443   SetGameStatus(GAME_MODE_PLAYING);
1444
1445   FadeOut(REDRAW_FIELD);
1446
1447   if (download_tape && !PlayScoreTape_WaitForDownload())
1448   {
1449     SetGameStatus(GAME_MODE_SCOREINFO);
1450     ClearField();
1451
1452     Request("Cannot download score tape from score server!", REQ_CONFIRM);
1453
1454     return FALSE;
1455   }
1456
1457   if (!TAPE_IS_STOPPED(tape))
1458     TapeStop();
1459
1460   // if tape recorder already contains a tape, remove it without asking
1461   TapeErase();
1462
1463   if (entry->id == -1)
1464     LoadScoreTape(entry->tape_basename, level_nr);
1465   else
1466     LoadScoreCacheTape(entry->tape_basename, level_nr);
1467
1468   if (TAPE_IS_EMPTY(tape))
1469   {
1470     SetGameStatus(GAME_MODE_SCOREINFO);
1471     ClearField();
1472
1473     Request("Cannot load score tape for this level!", REQ_CONFIRM);
1474
1475     return FALSE;
1476   }
1477
1478   FadeSkipNextFadeOut();
1479
1480   TapeStartGamePlaying();
1481
1482   score_info_tape_play = TRUE;
1483
1484   return TRUE;
1485 }
1486
1487 static boolean checkTapesFromSameLevel(struct TapeInfo *t1, struct TapeInfo *t2)
1488 {
1489   return (strEqual(t1->level_identifier, t2->level_identifier) &&
1490           t1->level_nr == t2->level_nr);
1491 }
1492
1493 static void CopyTape(struct TapeInfo *tape_from, struct TapeInfo *tape_to)
1494 {
1495   *tape_to = *tape_from;
1496 }
1497
1498 static void SwapTapes(struct TapeInfo *t1, struct TapeInfo *t2)
1499 {
1500   struct TapeInfo tmp = *t1;
1501
1502   *t1 = *t2;
1503   *t2 = tmp;
1504 }
1505
1506 static void CopyTapeToUndoBuffer(void)
1507 {
1508   // copy tapes to undo buffer if large enough (or larger than last undo tape)
1509   // or if the last undo tape is from a different level set or level number
1510   if (tape.length_seconds >= TAPE_MIN_SECONDS_FOR_UNDO_BUFFER ||
1511       tape.length_seconds >= tape_undo_buffer.length_seconds ||
1512       !checkTapesFromSameLevel(&tape, &tape_undo_buffer))
1513   {
1514     CopyTape(&tape, &tape_undo_buffer);
1515   }
1516 }
1517
1518 void UndoTape(void)
1519 {
1520   // only undo tapes from same level set and with same level number
1521   if (!checkTapesFromSameLevel(&tape, &tape_undo_buffer))
1522     return;
1523
1524   if (!TAPE_IS_STOPPED(tape))
1525     TapeStop();
1526
1527   // swap last recorded tape with undo buffer, so undo can be reversed
1528   SwapTapes(&tape, &tape_undo_buffer);
1529
1530   DrawCompleteVideoDisplay();
1531 }
1532
1533 void FixTape_ForceSinglePlayer(void)
1534 {
1535   int i;
1536
1537   /* fix single-player tapes that contain player input for more than one
1538      player (due to a bug in 3.3.1.2 and earlier versions), which results
1539      in playing levels with more than one player in multi-player mode,
1540      even though the tape was originally recorded in single-player mode */
1541
1542   // remove player input actions for all players but the first one
1543   for (i = 1; i < MAX_PLAYERS; i++)
1544     tape.player_participates[i] = FALSE;
1545
1546   tape.changed = TRUE;
1547 }
1548
1549
1550 // ----------------------------------------------------------------------------
1551 // tape autoplay functions
1552 // ----------------------------------------------------------------------------
1553
1554 static TreeInfo *getNextValidAutoPlayEntry(TreeInfo *node)
1555 {
1556   node = getNextValidTreeInfoEntry(node);
1557
1558   while (node && node->is_copy)
1559     node = getNextValidTreeInfoEntry(node);
1560
1561   return node;
1562 }
1563
1564 static TreeInfo *getFirstValidAutoPlayEntry(TreeInfo *node)
1565 {
1566   node = getFirstValidTreeInfoEntry(node);
1567
1568   if (node && node->is_copy)
1569     return getNextValidAutoPlayEntry(node);
1570
1571   return node;
1572 }
1573
1574 static void AutoPlayTapes_SetScoreEntry(int score, int time)
1575 {
1576   char *name = (options.mytapes ? setup.player_name : options.player_name);
1577
1578   // set unique basename for score tape (for uploading to score server)
1579   strcpy(tape.score_tape_basename, getScoreTapeBasename(name));
1580
1581   // store score in first score entry
1582   scores.last_added = 0;
1583
1584   struct ScoreEntry *entry = &scores.entry[scores.last_added];
1585
1586   strncpy(entry->tape_basename, tape.score_tape_basename, MAX_FILENAME_LEN);
1587   strncpy(entry->name, setup.player_name, MAX_PLAYER_NAME_LEN);
1588
1589   entry->score = score;
1590   entry->time = time;
1591
1592   PrintNoLog("- uploading score tape to score server ... ");
1593
1594   server_scores.uploaded = FALSE;
1595 }
1596
1597 static boolean AutoPlayTapes_WaitForUpload(void)
1598 {
1599   DelayCounter upload_delay = { 10000 };
1600
1601   ResetDelayCounter(&upload_delay);
1602
1603   // wait for score tape to be successfully uploaded (and fail on timeout)
1604   while (!server_scores.uploaded)
1605   {
1606     if (DelayReached(&upload_delay))
1607     {
1608       PrintNoLog("\r");
1609       Print("- uploading score tape to score server - TIMEOUT.\n");
1610
1611       if (program.headless)
1612         Fail("cannot upload score tape to score server");
1613
1614       return FALSE;
1615     }
1616
1617     UPDATE_BUSY_STATE();
1618
1619     Delay(20);
1620   }
1621
1622   PrintNoLog("\r");
1623   Print("- uploading score tape to score server - uploaded.\n");
1624
1625   return TRUE;
1626 }
1627
1628 static int AutoPlayTapesExt(boolean initialize)
1629 {
1630   static struct AutoPlayInfo autoplay;
1631   static int num_tapes = 0;
1632   static int patch_nr = 0;
1633   static char *patch_name[] =
1634   {
1635     "original tape",
1636     "em_random_bug",
1637     "screen_34x34",
1638
1639     NULL
1640   };
1641   static int patch_version_first[] =
1642   {
1643     VERSION_IDENT(0,0,0,0),
1644     VERSION_IDENT(3,3,1,0),
1645     VERSION_IDENT(0,0,0,0),
1646
1647     -1
1648   };
1649   static int patch_version_last[] =
1650   {
1651     VERSION_IDENT(9,9,9,9),
1652     VERSION_IDENT(4,0,1,1),
1653     VERSION_IDENT(4,2,2,0),
1654
1655     -1
1656   };
1657   static byte patch_property_bit[] =
1658   {
1659     TAPE_PROPERTY_NONE,
1660     TAPE_PROPERTY_EM_RANDOM_BUG,
1661     TAPE_PROPERTY_NONE,
1662
1663     -1
1664   };
1665   LevelDirTree *leveldir_current_last = leveldir_current;
1666   boolean init_level_set = FALSE;
1667   int level_nr_last = level_nr;
1668   int i;
1669
1670   if (!initialize)
1671   {
1672     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1673     {
1674       if (tape.auto_play_level_solved)
1675       {
1676         if (patch_nr > 0)
1677         {
1678           // level solved by patched tape -- save fixed tape
1679           char *filename = getTapeFilename(level_nr);
1680           char *filename_orig = getStringCat2(filename, ".orig");
1681
1682           // create backup from old tape, if not yet existing
1683           if (!fileExists(filename_orig))
1684             rename(filename, filename_orig);
1685
1686           SaveTapeToFilename(filename);
1687
1688           tape.auto_play_level_fixed = TRUE;
1689           autoplay.num_tapes_patched++;
1690         }
1691
1692         // continue with next tape
1693         patch_nr = 0;
1694       }
1695       else if (patch_name[patch_nr + 1] != NULL)
1696       {
1697         // level not solved by patched tape -- continue with next patch
1698         patch_nr++;
1699       }
1700       else
1701       {
1702         // level not solved by any patched tape -- continue with next tape
1703         tape.auto_play_level_not_fixable = TRUE;
1704         patch_nr = 0;
1705       }
1706     }
1707
1708     // just finished auto-playing tape
1709     PrintTapeReplayProgress(TRUE);
1710
1711     if (options.tape_log_filename != NULL)
1712       CloseTapeLogfile();
1713
1714     if (global.autoplay_mode == AUTOPLAY_MODE_SAVE &&
1715         tape.auto_play_level_solved)
1716     {
1717       AutoPlayTapes_SetScoreEntry(game.score_final, game.score_time_final);
1718
1719       if (leveldir_current)
1720       {
1721         // the tape's level set identifier may differ from current level set
1722         strncpy(tape.level_identifier, leveldir_current->identifier,
1723                 MAX_FILENAME_LEN);
1724         tape.level_identifier[MAX_FILENAME_LEN] = '\0';
1725
1726         // the tape's level number may differ from current level number
1727         tape.level_nr = level_nr;
1728       }
1729
1730       // save score tape to upload to server; may be required for some reasons:
1731       // * level set identifier in solution tapes may differ from level set
1732       // * level set identifier is missing (old-style tape without INFO chunk)
1733       // * solution tape may have native format (like Supaplex solution files)
1734
1735       SaveScoreTape(level_nr);
1736       SaveServerScore(level_nr, TRUE);
1737
1738       AutoPlayTapes_WaitForUpload();
1739     }
1740
1741     if (patch_nr == 0)
1742       autoplay.num_levels_played++;
1743
1744     if (tape.auto_play_level_solved)
1745       autoplay.num_levels_solved++;
1746
1747     if (level_nr >= 0 && level_nr < MAX_TAPES_PER_SET)
1748       autoplay.level_failed[level_nr] = !tape.auto_play_level_solved;
1749   }
1750   else
1751   {
1752     if (strEqual(global.autoplay_leveldir, "ALL"))
1753     {
1754       autoplay.all_levelsets = TRUE;
1755
1756       // tape mass-uploading only allowed for private tapes
1757       if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
1758         options.mytapes = TRUE;
1759     }
1760
1761     if ((global.autoplay_mode == AUTOPLAY_MODE_SAVE ||
1762          global.autoplay_mode == AUTOPLAY_MODE_UPLOAD) &&
1763         !options.mytapes &&
1764         options.player_name == NULL)
1765     {
1766       Fail("specify player name when uploading solution tapes");
1767     }
1768
1769     if (global.autoplay_mode != AUTOPLAY_MODE_UPLOAD)
1770       DrawCompleteVideoDisplay();
1771
1772     if (program.headless)
1773     {
1774       audio.sound_enabled = FALSE;
1775       setup.engine_snapshot_mode = getStringCopy(STR_SNAPSHOT_MODE_OFF);
1776     }
1777
1778     if (strSuffix(global.autoplay_leveldir, ".tape"))
1779     {
1780       autoplay.tape_filename = global.autoplay_leveldir;
1781
1782       if (!fileExists(autoplay.tape_filename))
1783         Fail("tape file '%s' does not exist", autoplay.tape_filename);
1784
1785       LoadTapeFromFilename(autoplay.tape_filename);
1786
1787       if (tape.no_valid_file)
1788         Fail("cannot load tape file '%s'", autoplay.tape_filename);
1789
1790       if (tape.no_info_chunk && !options.identifier)
1791         Fail("cannot get levelset from tape file '%s'", autoplay.tape_filename);
1792
1793       if (tape.no_info_chunk && !options.level_nr)
1794         Fail("cannot get level nr from tape file '%s'", autoplay.tape_filename);
1795
1796       global.autoplay_leveldir = tape.level_identifier;
1797
1798       if (options.identifier != NULL)
1799         global.autoplay_leveldir = options.identifier;
1800
1801       if (options.level_nr != NULL)
1802         tape.level_nr = atoi(options.level_nr);
1803
1804       if (tape.level_nr >= 0 && tape.level_nr < MAX_TAPES_PER_SET)
1805         global.autoplay_level[tape.level_nr] = TRUE;
1806
1807       global.autoplay_all = FALSE;
1808       options.mytapes = FALSE;
1809     }
1810
1811     if (autoplay.all_levelsets)
1812     {
1813       // start auto-playing first level set
1814       autoplay.leveldir = getFirstValidAutoPlayEntry(leveldir_first);
1815     }
1816     else
1817     {
1818       // auto-play selected level set
1819       autoplay.leveldir = getTreeInfoFromIdentifier(leveldir_first,
1820                                                     global.autoplay_leveldir);
1821     }
1822
1823     if (autoplay.leveldir == NULL)
1824       Fail("no such level identifier: '%s'", global.autoplay_leveldir);
1825
1826     // only private tapes may be modified
1827     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1828       options.mytapes = TRUE;
1829
1830     // set timestamp for batch tape upload
1831     global.autoplay_time = time(NULL);
1832
1833     num_tapes = 0;
1834
1835     init_level_set = TRUE;
1836   }
1837
1838   while (1)
1839   {
1840     if (init_level_set)
1841     {
1842       leveldir_current = autoplay.leveldir;
1843
1844       if (autoplay.leveldir->first_level < 0)
1845         autoplay.leveldir->first_level = 0;
1846       if (autoplay.leveldir->last_level >= MAX_TAPES_PER_SET)
1847         autoplay.leveldir->last_level = MAX_TAPES_PER_SET - 1;
1848
1849       autoplay.level_nr = autoplay.leveldir->first_level;
1850
1851       autoplay.num_levels_played = 0;
1852       autoplay.num_levels_solved = 0;
1853       autoplay.num_tapes_patched = 0;
1854       autoplay.num_tape_missing = 0;
1855
1856       for (i = 0; i < MAX_TAPES_PER_SET; i++)
1857         autoplay.level_failed[i] = FALSE;
1858
1859       PrintTapeReplayHeader(&autoplay);
1860
1861       init_level_set = FALSE;
1862     }
1863
1864     if (autoplay.all_levelsets && global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
1865     {
1866       boolean skip_levelset = FALSE;
1867
1868       if (!directoryExists(getTapeDir(autoplay.leveldir->subdir)))
1869       {
1870         Print("No tape directory for this level set found -- skipping.\n");
1871
1872         skip_levelset = TRUE;
1873       }
1874
1875       if (CheckTapeDirectoryUploadsComplete(autoplay.leveldir->subdir))
1876       {
1877         Print("All tapes for this level set already uploaded -- skipping.\n");
1878
1879         skip_levelset = TRUE;
1880       }
1881
1882       if (skip_levelset)
1883       {
1884         PrintTapeReplaySummary(&autoplay);
1885
1886         // continue with next level set
1887         autoplay.leveldir = getNextValidAutoPlayEntry(autoplay.leveldir);
1888
1889         // all level sets processed
1890         if (autoplay.leveldir == NULL)
1891           break;
1892
1893         init_level_set = TRUE;
1894
1895         continue;
1896       }
1897     }
1898
1899     if (global.autoplay_mode != AUTOPLAY_MODE_FIX || patch_nr == 0)
1900       level_nr = autoplay.level_nr++;
1901
1902     UPDATE_BUSY_STATE();
1903
1904     // check if all tapes for this level set have been processed
1905     if (level_nr > autoplay.leveldir->last_level)
1906     {
1907       PrintTapeReplaySummary(&autoplay);
1908
1909       if (!autoplay.all_levelsets)
1910         break;
1911
1912       if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
1913         MarkTapeDirectoryUploadsAsComplete(autoplay.leveldir->subdir);
1914
1915       // continue with next level set
1916       autoplay.leveldir = getNextValidAutoPlayEntry(autoplay.leveldir);
1917
1918       // all level sets processed
1919       if (autoplay.leveldir == NULL)
1920         break;
1921
1922       init_level_set = TRUE;
1923
1924       continue;
1925     }
1926
1927     // set patch info (required for progress output)
1928     strcpy(tape_patch_info, "");
1929     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1930       snprintf(tape_patch_info, MAX_OUTPUT_LINESIZE, "[%-13s] ",
1931                patch_name[patch_nr]);
1932
1933     if (!global.autoplay_all && !global.autoplay_level[level_nr])
1934       continue;
1935
1936     // speed things up in case of missing private tapes (skip loading level)
1937     if (options.mytapes && !fileExists(getTapeFilename(level_nr)))
1938     {
1939       autoplay.num_tape_missing++;
1940
1941       Print("Tape %03d: (no tape found)\n", level_nr);
1942
1943       continue;
1944     }
1945
1946     TapeErase();
1947     TapeRewind();       // needed to reset "tape.auto_play_level_solved"
1948
1949     LoadLevel(level_nr);
1950
1951     if (level.no_level_file || level.no_valid_file)
1952     {
1953       Print("Tape %03d: (no level found)\n", level_nr);
1954
1955       continue;
1956     }
1957
1958 #if 0
1959     // ACTIVATE THIS FOR LOADING/TESTING OF LEVELS ONLY
1960     Print("Tape %03d: (only testing level)\n", level_nr);
1961     continue;
1962 #endif
1963
1964     if (autoplay.tape_filename)
1965       LoadTapeFromFilename(autoplay.tape_filename);
1966     else if (options.mytapes)
1967       LoadTape(level_nr);
1968     else
1969       LoadSolutionTape(level_nr);
1970
1971     if (tape.no_valid_file)
1972     {
1973       autoplay.num_tape_missing++;
1974
1975       Print("Tape %03d: (no tape found)\n", level_nr);
1976
1977       continue;
1978     }
1979
1980     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1981     {
1982       boolean skip_patch = FALSE;
1983
1984       if (tape.engine_version < patch_version_first[patch_nr] ||
1985           tape.engine_version > patch_version_last[patch_nr])
1986       {
1987         Print("Tape %03d %s[%02d:%02d]: (%s %d.%d.%d.%d) - skipped.\n",
1988               level_nr,  tape_patch_info,
1989               tape.length_seconds / 60, tape.length_seconds % 60,
1990               "not suitable for version",
1991               (tape.engine_version / 1000000) % 100,
1992               (tape.engine_version / 10000  ) % 100,
1993               (tape.engine_version / 100    ) % 100,
1994               (tape.engine_version          ) % 100);
1995
1996         skip_patch = TRUE;
1997       }
1998
1999       if (strEqual(patch_name[patch_nr], "screen_34x34") &&
2000           tape.num_participating_players == 1)
2001       {
2002         Print("Tape %03d %s[%02d:%02d]: (%s) - skipped.\n",
2003               level_nr,  tape_patch_info,
2004               tape.length_seconds / 60, tape.length_seconds % 60,
2005               "not suitable for single player tapes");
2006
2007         skip_patch = TRUE;
2008       }
2009
2010       if (skip_patch)
2011       {
2012         if (patch_name[patch_nr + 1] != NULL)
2013         {
2014           // continue with next patch
2015           patch_nr++;
2016         }
2017         else
2018         {
2019           // continue with next tape
2020           patch_nr = 0;
2021         }
2022
2023         continue;
2024       }
2025
2026       if (strEqual(patch_name[patch_nr], "screen_34x34"))
2027       {
2028         tape.scr_fieldx = SCR_FIELDX_DEFAULT * 2;
2029         tape.scr_fieldy = SCR_FIELDY_DEFAULT * 2;
2030       }
2031       else
2032       {
2033         tape.property_bits |= patch_property_bit[patch_nr];
2034       }
2035     }
2036
2037     num_tapes++;
2038
2039     if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
2040     {
2041       boolean use_temporary_tape_file = FALSE;
2042
2043       Print("Tape %03d:\n", level_nr);
2044
2045       AutoPlayTapes_SetScoreEntry(0, 0);
2046
2047       if (autoplay.tape_filename == NULL)
2048       {
2049         autoplay.tape_filename = (options.mytapes ? getTapeFilename(level_nr) :
2050                                   getDefaultSolutionTapeFilename(level_nr));
2051
2052         if (!fileExists(autoplay.tape_filename))
2053         {
2054           // non-standard or incorrect solution tape -- save to temporary file
2055           autoplay.tape_filename = getTemporaryTapeFilename();
2056
2057           SaveTapeToFilename(autoplay.tape_filename);
2058
2059           use_temporary_tape_file = TRUE;
2060         }
2061       }
2062
2063       SaveServerScoreFromFile(level_nr, TRUE, autoplay.tape_filename);
2064
2065       boolean success = AutoPlayTapes_WaitForUpload();
2066
2067       if (use_temporary_tape_file)
2068         unlink(autoplay.tape_filename);
2069
2070       // required for uploading multiple tapes
2071       autoplay.tape_filename = NULL;
2072
2073       if (!success)
2074       {
2075         num_tapes = -num_tapes;
2076
2077         break;
2078       }
2079
2080       continue;
2081     }
2082
2083     InitCounter();
2084
2085     if (options.tape_log_filename != NULL)
2086       OpenTapeLogfile();
2087
2088     TapeStartGamePlaying();
2089     TapeStartWarpForward(global.autoplay_mode);
2090
2091     autoplay.last_level_nr = level_nr;
2092
2093     return num_tapes;
2094   }
2095
2096   if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
2097   {
2098     Print("\n");
2099     PrintLine("=", 79);
2100
2101     if (num_tapes >= 0)
2102       Print("SUMMARY: %d tapes uploaded.\n", num_tapes);
2103     else
2104       Print("SUMMARY: Uploading tapes failed.\n");
2105
2106     PrintLine("=", 79);
2107   }
2108
2109   // clear timestamp for batch tape upload (required after interactive upload)
2110   global.autoplay_time = 0;
2111
2112   // exit if running headless or if visually auto-playing tapes
2113   if (program.headless || global.autoplay_mode != AUTOPLAY_MODE_UPLOAD)
2114     CloseAllAndExit(0);
2115
2116   // when running interactively, restore last selected level set and number
2117   leveldir_current = leveldir_current_last;
2118   level_nr = level_nr_last;
2119
2120   return num_tapes;
2121 }
2122
2123 int AutoPlayTapes(void)
2124 {
2125   return AutoPlayTapesExt(TRUE);
2126 }
2127
2128 int AutoPlayTapesContinue(void)
2129 {
2130   return AutoPlayTapesExt(FALSE);
2131 }
2132
2133
2134 // ----------------------------------------------------------------------------
2135 // tape patch functions
2136 // ----------------------------------------------------------------------------
2137
2138 static boolean PatchTape(struct TapeInfo *tape, char *mode)
2139 {
2140   Print("[%d.%d.%d.%d]: ",
2141         (tape->engine_version / 1000000) % 100,
2142         (tape->engine_version / 10000  ) % 100,
2143         (tape->engine_version / 100    ) % 100,
2144         (tape->engine_version          ) % 100);
2145
2146   if (strEqual(mode, "info"))
2147   {
2148     Print("property bits == 0x%02x\n", tape->property_bits);
2149
2150     return FALSE;
2151   }
2152
2153   boolean unpatch_tape = FALSE;
2154   boolean use_property_bit = FALSE;
2155   byte property_bitmask = 0;
2156
2157   if (strSuffix(mode, ":0") ||
2158       strSuffix(mode, ":off") ||
2159       strSuffix(mode, ":clear"))
2160     unpatch_tape = TRUE;
2161
2162   if (strEqual(mode, "em_random_bug") || strPrefix(mode, "em_random_bug:"))
2163   {
2164     // this bug was introduced in version 3.3.1.0 and fixed in version 4.0.1.2
2165     if (tape->engine_version <  VERSION_IDENT(3,3,1,0) ||
2166         tape->engine_version >= VERSION_IDENT(4,0,1,2))
2167     {
2168       Print("This tape version cannot be patched against EM random bug!\n");
2169
2170       return FALSE;
2171     }
2172
2173     property_bitmask = TAPE_PROPERTY_EM_RANDOM_BUG;
2174
2175     use_property_bit = TRUE;
2176   }
2177   else if (strEqual(mode, "screen_34x34") || strPrefix(mode, "screen_34x34:"))
2178   {
2179     // this bug only affects team mode tapes
2180     if (tape->num_participating_players == 1)
2181     {
2182       Print("Only team mode tapes can be patched against screen size bug!\n");
2183
2184       return FALSE;
2185     }
2186
2187     // this bug (that always existed before) was fixed in version 4.2.2.1
2188     if (tape->engine_version >= VERSION_IDENT(4,2,2,1))
2189     {
2190       Print("This tape version cannot be patched against screen size bug!\n");
2191
2192       return FALSE;
2193     }
2194
2195     int factor = (unpatch_tape ? 1 : 2);
2196     int scr_fieldx_new = SCR_FIELDX_DEFAULT * factor;
2197     int scr_fieldy_new = SCR_FIELDY_DEFAULT * factor;
2198
2199     if (scr_fieldx_new == tape->scr_fieldx &&
2200         scr_fieldy_new == tape->scr_fieldy)
2201     {
2202       Print("Tape already patched for '%s'!\n", mode);
2203
2204       return FALSE;
2205     }
2206
2207     tape->scr_fieldx = scr_fieldx_new;
2208     tape->scr_fieldy = scr_fieldy_new;
2209   }
2210   else
2211   {
2212     Print("Unknown patch mode '%s'!\n", mode);
2213
2214     return FALSE;
2215   }
2216
2217   // patching tapes using property bits may be used for several patch modes
2218   if (use_property_bit)
2219   {
2220     byte property_bits = tape->property_bits;
2221     boolean set_property_bit = (unpatch_tape ? FALSE : TRUE);
2222
2223     if (set_property_bit)
2224       property_bits |= property_bitmask;
2225     else
2226       property_bits &= ~property_bitmask;
2227
2228     if (property_bits == tape->property_bits)
2229     {
2230       Print("Tape already patched for '%s'!\n", mode);
2231
2232       return FALSE;
2233     }
2234
2235     tape->property_bits = property_bits;
2236   }
2237
2238   Print("Patching for '%s' ... ", mode);
2239
2240   return TRUE;
2241 }
2242
2243 void PatchTapes(void)
2244 {
2245   static LevelDirTree *patchtapes_leveldir = NULL;
2246   static int num_tapes_found = 0;
2247   static int num_tapes_patched = 0;
2248   char *mode = global.patchtapes_mode;
2249   int i;
2250
2251   if (strEqual(mode, "help"))
2252   {
2253     PrintLine("=", 79);
2254     Print("Supported patch modes:\n");
2255     Print("- \"em_random_bug\"   - use 64-bit random value bug for EM engine\n");
2256     Print("- \"screen_34x34\"    - force visible playfield size of 34 x 34\n");
2257     PrintLine("-", 79);
2258     Print("Supported modifiers:\n");
2259     Print("- add \":0\", \":off\" or \":clear\" to patch mode to un-patch tape file\n");
2260     PrintLine("=", 79);
2261
2262     CloseAllAndExit(0);
2263   }
2264
2265   patchtapes_leveldir = getTreeInfoFromIdentifier(leveldir_first,
2266                                                   global.patchtapes_leveldir);
2267
2268   if (patchtapes_leveldir == NULL)
2269     Fail("no such level identifier: '%s'", global.patchtapes_leveldir);
2270
2271   leveldir_current = patchtapes_leveldir;
2272
2273   if (patchtapes_leveldir->first_level < 0)
2274     patchtapes_leveldir->first_level = 0;
2275   if (patchtapes_leveldir->last_level >= MAX_TAPES_PER_SET)
2276     patchtapes_leveldir->last_level = MAX_TAPES_PER_SET - 1;
2277
2278   PrintLine("=", 79);
2279   Print("Patching level tapes for patch mode '%s'\n", mode);
2280   PrintLine("-", 79);
2281   Print("Level series identifier: '%s'\n", patchtapes_leveldir->identifier);
2282   Print("Level series name:       '%s'\n", patchtapes_leveldir->name);
2283   Print("Level series author:     '%s'\n", patchtapes_leveldir->author);
2284   Print("Number of levels:        %d\n",   patchtapes_leveldir->levels);
2285   PrintLine("=", 79);
2286   Print("\n");
2287
2288   int first_level = patchtapes_leveldir->first_level;
2289   int last_level = patchtapes_leveldir->last_level;
2290
2291   for (i = first_level; i <= last_level; i++)
2292   {
2293     if (!global.patchtapes_all && !global.patchtapes_level[i])
2294       continue;
2295
2296     Print("Tape %03d: ", i);
2297
2298     TapeErase();
2299     LoadTape(i);
2300
2301     if (tape.no_valid_file)
2302     {
2303       Print("(no tape found)\n");
2304
2305       continue;
2306     }
2307
2308     num_tapes_found++;
2309
2310     if (PatchTape(&tape, mode))
2311     {
2312       char *filename = getTapeFilename(i);
2313       char *filename_orig = getStringCat2(filename, ".orig");
2314
2315       if (!fileExists(filename_orig))
2316         rename(filename, filename_orig);
2317
2318       SaveTapeToFilename(filename);
2319
2320       Print("patched tape saved.\n");
2321
2322       num_tapes_patched++;
2323     }
2324   }
2325
2326   Print("\n");
2327   PrintLine("=", 79);
2328   Print("Number of tapes found: %d\n", num_tapes_found);
2329   Print("Number of tapes patched: %d\n", num_tapes_patched);
2330   PrintLine("=", 79);
2331
2332   CloseAllAndExit(0);
2333 }
2334
2335
2336 // ---------- new tape button stuff -------------------------------------------
2337
2338 static struct
2339 {
2340   int graphic;
2341   struct XY *pos;
2342   int gadget_id;
2343   char *infotext;
2344 } tapebutton_info[NUM_TAPE_BUTTONS] =
2345 {
2346   {
2347     IMG_GFX_TAPE_BUTTON_EJECT,          &tape.button.eject,
2348     TAPE_CTRL_ID_EJECT,                 "eject tape"
2349   },
2350   {
2351     // (same position as "eject" button)
2352     IMG_GFX_TAPE_BUTTON_EXTRA,          &tape.button.eject,
2353     TAPE_CTRL_ID_EXTRA,                 "extra functions"
2354   },
2355   {
2356     IMG_GFX_TAPE_BUTTON_STOP,           &tape.button.stop,
2357     TAPE_CTRL_ID_STOP,                  "stop tape"
2358   },
2359   {
2360     IMG_GFX_TAPE_BUTTON_PAUSE,          &tape.button.pause,
2361     TAPE_CTRL_ID_PAUSE,                 "pause tape"
2362   },
2363   {
2364     IMG_GFX_TAPE_BUTTON_RECORD,         &tape.button.record,
2365     TAPE_CTRL_ID_RECORD,                "record tape"
2366   },
2367   {
2368     IMG_GFX_TAPE_BUTTON_PLAY,           &tape.button.play,
2369     TAPE_CTRL_ID_PLAY,                  "play tape"
2370   },
2371   {
2372     IMG_GFX_TAPE_BUTTON_INSERT_SOLUTION,&tape.button.insert_solution,
2373     TAPE_CTRL_ID_INSERT_SOLUTION,       "insert solution tape"
2374   },
2375   {
2376     IMG_GFX_TAPE_BUTTON_PLAY_SOLUTION,  &tape.button.play_solution,
2377     TAPE_CTRL_ID_PLAY_SOLUTION,         "play solution tape"
2378   }
2379 };
2380
2381 void CreateTapeButtons(void)
2382 {
2383   int i;
2384
2385   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2386   {
2387     int graphic = tapebutton_info[i].graphic;
2388     struct GraphicInfo *gfx = &graphic_info[graphic];
2389     struct XY *pos = tapebutton_info[i].pos;
2390     struct GadgetInfo *gi;
2391     int gd_x = gfx->src_x;
2392     int gd_y = gfx->src_y;
2393     int gd_xp = gfx->src_x + gfx->pressed_xoffset;
2394     int gd_yp = gfx->src_y + gfx->pressed_yoffset;
2395     int id = i;
2396
2397     gi = CreateGadget(GDI_CUSTOM_ID, id,
2398                       GDI_IMAGE_ID, graphic,
2399                       GDI_INFO_TEXT, tapebutton_info[i].infotext,
2400                       GDI_X, VX + pos->x,
2401                       GDI_Y, VY + pos->y,
2402                       GDI_WIDTH, gfx->width,
2403                       GDI_HEIGHT, gfx->height,
2404                       GDI_TYPE, GD_TYPE_NORMAL_BUTTON,
2405                       GDI_STATE, GD_BUTTON_UNPRESSED,
2406                       GDI_DESIGN_UNPRESSED, gfx->bitmap, gd_x, gd_y,
2407                       GDI_DESIGN_PRESSED, gfx->bitmap, gd_xp, gd_yp,
2408                       GDI_DIRECT_DRAW, FALSE,
2409                       GDI_EVENT_MASK, GD_EVENT_RELEASED,
2410                       GDI_CALLBACK_ACTION, HandleTapeButtons,
2411                       GDI_END);
2412
2413     if (gi == NULL)
2414       Fail("cannot create gadget");
2415
2416     tape_gadget[id] = gi;
2417   }
2418 }
2419
2420 void FreeTapeButtons(void)
2421 {
2422   int i;
2423
2424   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2425     FreeGadget(tape_gadget[i]);
2426 }
2427
2428 void MapTapeEjectButton(void)
2429 {
2430   UnmapGadget(tape_gadget[TAPE_CTRL_ID_EXTRA]);
2431   MapGadget(tape_gadget[TAPE_CTRL_ID_EJECT]);
2432 }
2433
2434 void MapTapeWarpButton(void)
2435 {
2436   UnmapGadget(tape_gadget[TAPE_CTRL_ID_EJECT]);
2437   MapGadget(tape_gadget[TAPE_CTRL_ID_EXTRA]);
2438 }
2439
2440 void MapTapeButtons(void)
2441 {
2442   int i;
2443
2444   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2445     if (i != TAPE_CTRL_ID_EXTRA)
2446       MapGadget(tape_gadget[i]);
2447
2448   if (tape.recording || tape.playing)
2449     MapTapeWarpButton();
2450
2451   if (tape.show_game_buttons)
2452     MapGameButtonsOnTape();
2453 }
2454
2455 void UnmapTapeButtons(void)
2456 {
2457   int i;
2458
2459   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2460     UnmapGadget(tape_gadget[i]);
2461
2462   if (tape.show_game_buttons)
2463     UnmapGameButtonsOnTape();
2464 }
2465
2466 void RedrawTapeButtons(void)
2467 {
2468   int i;
2469
2470   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2471     RedrawGadget(tape_gadget[i]);
2472
2473   if (tape.show_game_buttons)
2474     RedrawGameButtonsOnTape();
2475 }
2476
2477 void RedrawOrRemapTapeButtons(void)
2478 {
2479   if (tape_gadget[TAPE_CTRL_ID_PLAY]->mapped)
2480   {
2481     // tape buttons already mapped
2482     RedrawTapeButtons();
2483   }
2484   else
2485   {
2486     UnmapTapeButtons();
2487     MapTapeButtons();
2488   }
2489 }
2490
2491 static void HandleTapeButtonsExt(int id)
2492 {
2493   if (game_status != GAME_MODE_MAIN && game_status != GAME_MODE_PLAYING)
2494     return;
2495
2496   switch (id)
2497   {
2498     case TAPE_CTRL_ID_EJECT:
2499       TapeStop();
2500
2501       if (TAPE_IS_EMPTY(tape))
2502       {
2503         LoadTape(level_nr);
2504
2505         if (TAPE_IS_EMPTY(tape))
2506           Request("No tape for this level!", REQ_CONFIRM);
2507       }
2508       else
2509       {
2510         if (tape.changed)
2511           SaveTapeChecked(level_nr);
2512
2513         TapeErase();
2514       }
2515
2516       DrawCompleteVideoDisplay();
2517       break;
2518
2519     case TAPE_CTRL_ID_EXTRA:
2520       if (tape.playing)
2521       {
2522         tape.pause_before_end = !tape.pause_before_end;
2523
2524         DrawVideoDisplayCurrentState();
2525       }
2526       else if (tape.recording)
2527       {
2528         TapeSingleStep();
2529       }
2530
2531       break;
2532
2533     case TAPE_CTRL_ID_STOP:
2534       TapeStopTape();
2535
2536       break;
2537
2538     case TAPE_CTRL_ID_PAUSE:
2539       TapeTogglePause(TAPE_TOGGLE_MANUAL);
2540
2541       break;
2542
2543     case TAPE_CTRL_ID_RECORD:
2544       if (TAPE_IS_STOPPED(tape))
2545       {
2546         TapeStartGameRecording();
2547       }
2548       else if (tape.pausing)
2549       {
2550         if (tape.playing)                       // PLAY -> PAUSE -> RECORD
2551           TapeAppendRecording();
2552         else
2553           TapeTogglePause(TAPE_TOGGLE_MANUAL);
2554       }
2555
2556       break;
2557
2558     case TAPE_CTRL_ID_PLAY:
2559       if (tape.recording && tape.pausing)       // PAUSE -> RECORD
2560       {
2561         // ("TAPE_IS_EMPTY(tape)" is TRUE here -- probably fix this)
2562
2563         TapeTogglePause(TAPE_TOGGLE_MANUAL);
2564       }
2565
2566       if (TAPE_IS_EMPTY(tape))
2567         break;
2568
2569       if (TAPE_IS_STOPPED(tape))
2570       {
2571         TapeStartGamePlaying();
2572       }
2573       else if (tape.playing)
2574       {
2575         if (tape.pausing)                       // PAUSE -> PLAY
2576         {
2577           TapeTogglePause(TAPE_TOGGLE_MANUAL | TAPE_TOGGLE_PLAY_PAUSE);
2578         }
2579         else if (!tape.fast_forward)            // PLAY -> FFWD
2580         {
2581           tape.fast_forward = TRUE;
2582         }
2583         else if (!tape.warp_forward)            // FFWD -> WARP
2584         {
2585           tape.warp_forward = TRUE;
2586         }
2587         else if (!tape.deactivate_display)      // WARP -> WARP BLIND
2588         {
2589           tape.deactivate_display = TRUE;
2590
2591           TapeDeactivateDisplayOn();
2592         }
2593         else                                    // WARP BLIND -> PLAY
2594         {
2595           tape.fast_forward = FALSE;
2596           tape.warp_forward = FALSE;
2597           tape.deactivate_display = FALSE;
2598
2599           TapeDeactivateDisplayOff(game_status == GAME_MODE_PLAYING);
2600         }
2601
2602         DrawVideoDisplayCurrentState();
2603       }
2604
2605       break;
2606
2607     case TAPE_CTRL_ID_INSERT_SOLUTION:
2608       InsertSolutionTape();
2609
2610       break;
2611
2612     case TAPE_CTRL_ID_PLAY_SOLUTION:
2613       PlaySolutionTape();
2614
2615       break;
2616
2617     default:
2618       break;
2619   }
2620 }
2621
2622 static void HandleTapeButtons(struct GadgetInfo *gi)
2623 {
2624   HandleTapeButtonsExt(gi->custom_id);
2625 }
2626
2627 void HandleTapeButtonKeys(Key key)
2628 {
2629   boolean eject_button_is_active = TAPE_IS_STOPPED(tape);
2630   boolean extra_button_is_active = !eject_button_is_active;
2631
2632   if (key == setup.shortcut.tape_eject && eject_button_is_active)
2633     HandleTapeButtonsExt(TAPE_CTRL_ID_EJECT);
2634   else if (key == setup.shortcut.tape_extra && extra_button_is_active)
2635     HandleTapeButtonsExt(TAPE_CTRL_ID_EXTRA);
2636   else if (key == setup.shortcut.tape_stop)
2637     HandleTapeButtonsExt(TAPE_CTRL_ID_STOP);
2638   else if (key == setup.shortcut.tape_pause)
2639     HandleTapeButtonsExt(TAPE_CTRL_ID_PAUSE);
2640   else if (key == setup.shortcut.tape_record)
2641     HandleTapeButtonsExt(TAPE_CTRL_ID_RECORD);
2642   else if (key == setup.shortcut.tape_play)
2643     HandleTapeButtonsExt(TAPE_CTRL_ID_PLAY);
2644 }