added code to convert native Boulder Dash tapes
[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 TapeSetDateFromIsoDateString(char *date)
633 {
634   int i;
635
636   // check ISO date string for correct length
637   if (strlen(date) != 10)
638     return;
639
640   // check ISO date string for correct format
641   for (i = 0; i < strlen(date); i++)
642     if (((i != 4 && i != 7) && (date[i] < '0' || date[i] > '9')) ||
643         ((i == 4 || i == 7) && (date[i] != '-')))
644       return;
645
646   int yy = (date[2] - '0') * 10 + (date[3] - '0');
647   int mm = (date[5] - '0') * 10 + (date[6] - '0');
648   int dd = (date[8] - '0') * 10 + (date[9] - '0');
649
650   if (mm < 1 || mm > 12 || dd < 1 || dd > 31)
651     return;
652
653   tape.date = 10000 * yy + 100 * (mm - 1) + dd;
654 }
655
656 void TapeSetDateFromEpochSeconds(time_t epoch_seconds)
657 {
658   struct tm *lt = localtime(&epoch_seconds);
659
660   tape.date = 10000 * (lt->tm_year % 100) + 100 * lt->tm_mon + lt->tm_mday;
661 }
662
663 void TapeSetDateFromNow(void)
664 {
665   TapeSetDateFromEpochSeconds(time(NULL));
666 }
667
668 void TapeErase(void)
669 {
670   int i;
671
672   CopyTapeToUndoBuffer();
673
674   tape.counter = 0;
675   tape.length = 0;
676   tape.length_frames = 0;
677   tape.length_seconds = 0;
678
679   tape.score_tape_basename[0] = '\0';
680
681   if (leveldir_current)
682   {
683     strncpy(tape.level_identifier, leveldir_current->identifier,
684             MAX_FILENAME_LEN);
685     tape.level_identifier[MAX_FILENAME_LEN] = '\0';
686   }
687
688   tape.level_nr = level_nr;
689   tape.pos[tape.counter].delay = 0;
690   tape.changed = TRUE;
691   tape.solved = FALSE;
692
693   tape.random_seed = InitRND(level.random_seed);
694
695   tape.file_version = FILE_VERSION_ACTUAL;
696   tape.game_version = GAME_VERSION_ACTUAL;
697   tape.engine_version = level.game_version;
698
699   tape.property_bits = TAPE_PROPERTY_NONE;
700
701   TapeSetDateFromNow();
702
703   for (i = 0; i < MAX_PLAYERS; i++)
704     tape.player_participates[i] = FALSE;
705
706   tape.centered_player_nr_next = -1;
707   tape.set_centered_player = FALSE;
708
709   // set flags for game actions to default values (may be overwritten later)
710   tape.use_key_actions = TRUE;
711   tape.use_mouse_actions = FALSE;
712 }
713
714 static void TapeRewind(void)
715 {
716   tape.counter = 0;
717   tape.delay_played = 0;
718   tape.pause_before_end = FALSE;
719   tape.recording = FALSE;
720   tape.playing = FALSE;
721   tape.fast_forward = FALSE;
722   tape.warp_forward = FALSE;
723   tape.deactivate_display = FALSE;
724   tape.auto_play = (global.autoplay_leveldir != NULL);
725   tape.auto_play_level_solved = FALSE;
726   tape.auto_play_level_fixed = FALSE;
727   tape.auto_play_level_not_fixable = FALSE;
728   tape.quick_resume = FALSE;
729   tape.single_step = FALSE;
730
731   tape.centered_player_nr_next = -1;
732   tape.set_centered_player = FALSE;
733
734   InitRND(tape.random_seed);
735 }
736
737 static void TapeSetRandomSeed(int random_seed)
738 {
739   tape.random_seed = InitRND(random_seed);
740 }
741
742 void TapeStartRecording(int random_seed)
743 {
744   if (!TAPE_IS_STOPPED(tape))
745     TapeStop();
746
747   TapeErase();
748   TapeRewind();
749   TapeSetRandomSeed(random_seed);
750
751   tape.recording = TRUE;
752
753   DrawVideoDisplay(VIDEO_STATE_REC_ON, 0);
754   DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
755   DrawVideoDisplay(VIDEO_STATE_TIME_ON, 0);
756   DrawVideoDisplay(VIDEO_STATE_FRAME_ON, 0);
757
758   MapTapeWarpButton();
759
760   SetDrawDeactivationMask(REDRAW_NONE);
761   audio.sound_deactivated = FALSE;
762
763   // required here to update video display if tape door is closed
764   if (GetDoorState() & DOOR_CLOSE_2)
765     OpenDoor(GetDoorState() | DOOR_NO_DELAY | DOOR_FORCE_REDRAW);
766 }
767
768 static void TapeStartGameRecording(void)
769 {
770   StartGameActions(network.enabled, TRUE, level.random_seed);
771 }
772
773 static void TapeAppendRecording(void)
774 {
775   if (!tape.playing || !tape.pausing)
776     return;
777
778   // stop playing
779   tape.playing = FALSE;
780   tape.fast_forward = FALSE;
781   tape.warp_forward = FALSE;
782   tape.pause_before_end = FALSE;
783   tape.deactivate_display = FALSE;
784
785   // start recording
786   tape.recording = TRUE;
787   tape.changed = TRUE;
788   tape.solved = FALSE;
789
790   // set current delay (for last played move)
791   tape.pos[tape.counter].delay = tape.delay_played;
792
793   tape.property_bits |= TAPE_PROPERTY_REPLAYED;
794
795   // set current date
796   TapeSetDateFromNow();
797
798   DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
799   DrawVideoDisplay(VIDEO_STATE_PLAY_OFF | VIDEO_STATE_REC_ON, 0);
800
801   UpdateAndDisplayGameControlValues();
802 }
803
804 void TapeHaltRecording(void)
805 {
806   // only advance tape counter if any input events have been recorded
807   if (tape.pos[tape.counter].delay > 0)
808     tape.counter++;
809
810   // initialize delay for next tape entry (to be able to continue recording)
811   if (tape.counter < MAX_TAPE_LEN)
812     tape.pos[tape.counter].delay = 0;
813
814   tape.length = tape.counter;
815   tape.length_frames = GetTapeLengthFrames();
816   tape.length_seconds = GetTapeLengthSeconds();
817 }
818
819 void TapeStopRecording(void)
820 {
821   if (tape.recording)
822     TapeHaltRecording();
823
824   tape.recording = FALSE;
825   tape.pausing = FALSE;
826
827   DrawVideoDisplay(VIDEO_STATE_REC_OFF, 0);
828   MapTapeEjectButton();
829 }
830
831 boolean TapeAddAction(byte action[MAX_TAPE_ACTIONS])
832 {
833   int i;
834
835   if (tape.pos[tape.counter].delay > 0)         // already stored action
836   {
837     boolean changed_events = FALSE;
838
839     for (i = 0; i < MAX_TAPE_ACTIONS; i++)
840       if (tape.pos[tape.counter].action[i] != action[i])
841         changed_events = TRUE;
842
843     if (changed_events || tape.pos[tape.counter].delay >= 255)
844     {
845       if (tape.counter >= MAX_TAPE_LEN - 1)
846         return FALSE;
847
848       tape.counter++;
849       tape.pos[tape.counter].delay = 0;
850     }
851     else
852       tape.pos[tape.counter].delay++;
853   }
854
855   if (tape.pos[tape.counter].delay == 0)        // store new action
856   {
857     for (i = 0; i < MAX_TAPE_ACTIONS; i++)
858       tape.pos[tape.counter].action[i] = action[i];
859
860     tape.pos[tape.counter].delay++;
861   }
862
863   tape.changed = TRUE;
864
865   return TRUE;
866 }
867
868 void TapeRecordAction(byte action_raw[MAX_TAPE_ACTIONS])
869 {
870   byte action[MAX_TAPE_ACTIONS];
871   int i;
872
873   if (!tape.recording)          // (record action even when tape is paused)
874     return;
875
876   for (i = 0; i < MAX_TAPE_ACTIONS; i++)
877     action[i] = action_raw[i];
878
879   if (tape.use_key_actions && tape.set_centered_player)
880   {
881     for (i = 0; i < MAX_PLAYERS; i++)
882       if (tape.centered_player_nr_next == i ||
883           tape.centered_player_nr_next == -1)
884         action[i] |= KEY_SET_FOCUS;
885
886     tape.set_centered_player = FALSE;
887   }
888
889   if (GameFrameDelay != GAME_FRAME_DELAY)
890     tape.property_bits |= TAPE_PROPERTY_GAME_SPEED;
891
892   if (setup.small_game_graphics || SCR_FIELDX >= 2 * SCR_FIELDX_DEFAULT)
893     tape.property_bits |= TAPE_PROPERTY_SMALL_GRAPHICS;
894
895   if (!TapeAddAction(action))
896     TapeStopRecording();
897 }
898
899 void TapeTogglePause(boolean toggle_mode)
900 {
901   if (tape.playing && tape.pausing && (toggle_mode & TAPE_TOGGLE_PLAY_PAUSE))
902   {
903     // continue playing in normal mode
904     tape.fast_forward = FALSE;
905     tape.warp_forward = FALSE;
906     tape.deactivate_display = FALSE;
907
908     tape.pause_before_end = FALSE;
909   }
910
911   tape.pausing = !tape.pausing;
912
913   if (tape.single_step && (toggle_mode & TAPE_TOGGLE_MANUAL))
914     tape.single_step = FALSE;
915
916   if (tape.single_step)
917     tape.property_bits |= TAPE_PROPERTY_SINGLE_STEP;
918
919   if (tape.pausing)
920     tape.property_bits |= TAPE_PROPERTY_PAUSE_MODE;
921
922   DrawVideoDisplayCurrentState();
923
924   if (tape.deactivate_display)
925   {
926     if (tape.pausing)
927       TapeDeactivateDisplayOff(game_status == GAME_MODE_PLAYING);
928     else
929       TapeDeactivateDisplayOn();
930   }
931
932   if (tape.quick_resume)
933   {
934     tape.quick_resume = FALSE;
935
936     TapeStopWarpForward();
937     TapeAppendRecording();
938
939     if (!CheckEngineSnapshotSingle())
940       SaveEngineSnapshotSingle();
941
942     // restart step/move snapshots after quick loading tape
943     SaveEngineSnapshotToListInitial();
944
945     // do not map undo/redo buttons after quick loading tape
946     return;
947   }
948
949   if (game_status == GAME_MODE_PLAYING)
950   {
951     if (setup.show_load_save_buttons &&
952         setup.show_undo_redo_buttons &&
953         CheckEngineSnapshotList())
954     {
955       if (tape.pausing)
956         MapUndoRedoButtons();
957       else if (!tape.single_step)
958         MapLoadSaveButtons();
959     }
960
961     ModifyPauseButtons();
962   }
963
964   // stop tape when leaving auto-pause after completely replaying tape
965   if (tape.playing && !tape.pausing && tape.counter >= tape.length)
966     TapeStop();
967 }
968
969 void TapeStartPlaying(void)
970 {
971   if (TAPE_IS_EMPTY(tape))
972     return;
973
974   if (!TAPE_IS_STOPPED(tape))
975     TapeStop();
976
977   TapeRewind();
978
979   tape.playing = TRUE;
980
981   DrawVideoDisplay(VIDEO_STATE_PLAY_ON, 0);
982   DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
983   DrawVideoDisplay(VIDEO_STATE_TIME_ON, 0);
984   DrawVideoDisplay(VIDEO_STATE_FRAME_ON, 0);
985
986   MapTapeWarpButton();
987
988   SetDrawDeactivationMask(REDRAW_NONE);
989   audio.sound_deactivated = FALSE;
990 }
991
992 static void TapeStartGamePlaying(void)
993 {
994   TapeStartPlaying();
995
996   InitGame();
997 }
998
999 void TapeStopPlaying(void)
1000 {
1001   tape.playing = FALSE;
1002   tape.pausing = FALSE;
1003
1004   if (tape.warp_forward)
1005     TapeStopWarpForward();
1006
1007   DrawVideoDisplay(VIDEO_STATE_PLAY_OFF, 0);
1008   MapTapeEjectButton();
1009 }
1010
1011 byte *TapePlayAction(void)
1012 {
1013   int update_delay = FRAMES_PER_SECOND / 2;
1014   boolean update_video_display = (FrameCounter % update_delay == 0);
1015   boolean update_draw_label_on = ((FrameCounter / update_delay) % 2 == 1);
1016   static byte action[MAX_TAPE_ACTIONS];
1017   int i;
1018
1019   if (!tape.playing || tape.pausing)
1020     return NULL;
1021
1022   if (tape.pause_before_end)  // stop some seconds before end of tape
1023   {
1024     if (TapeTime > (int)tape.length_seconds - TAPE_PAUSE_SECONDS_BEFORE_DEATH)
1025     {
1026       TapeStopWarpForward();
1027       TapeTogglePause(TAPE_TOGGLE_MANUAL);
1028
1029       if (setup.autorecord_after_replay)
1030         TapeAppendRecording();
1031
1032       return NULL;
1033     }
1034   }
1035
1036   if (tape.counter >= tape.length)      // end of tape reached
1037   {
1038     if (!tape.auto_play)
1039     {
1040       TapeStopWarpForward();
1041       TapeTogglePause(TAPE_TOGGLE_MANUAL);
1042
1043       if (setup.autorecord_after_replay)
1044         TapeAppendRecording();
1045     }
1046     else
1047     {
1048       TapeStop();
1049     }
1050
1051     return NULL;
1052   }
1053
1054   if (update_video_display && !tape.deactivate_display)
1055   {
1056     int state = 0;
1057
1058     if (tape.warp_forward)
1059       state |= VIDEO_STATE_WARP(update_draw_label_on);
1060     else if (tape.fast_forward)
1061       state |= VIDEO_STATE_FFWD(update_draw_label_on);
1062
1063     if (tape.pause_before_end)
1064       state |= VIDEO_STATE_PBEND(update_draw_label_on);
1065
1066     // draw labels and symbols separately to prevent labels overlapping symbols
1067     DrawVideoDisplayLabel(state);
1068     DrawVideoDisplaySymbol(state);
1069   }
1070
1071   for (i = 0; i < MAX_TAPE_ACTIONS; i++)
1072     action[i] = tape.pos[tape.counter].action[i];
1073
1074 #if DEBUG_TAPE_WHEN_PLAYING
1075   DebugContinued("", "%05d", FrameCounter);
1076   for (i = 0; i < MAX_TAPE_ACTIONS; i++)
1077     DebugContinued("", "   %08x", action[i]);
1078   DebugContinued("tape:play", "\n");
1079 #endif
1080
1081   tape.set_centered_player = FALSE;
1082   tape.centered_player_nr_next = -999;
1083
1084   if (tape.use_key_actions)
1085   {
1086     for (i = 0; i < MAX_PLAYERS; i++)
1087     {
1088       if (action[i] & KEY_SET_FOCUS)
1089       {
1090         tape.set_centered_player = TRUE;
1091         tape.centered_player_nr_next =
1092           (tape.centered_player_nr_next == -999 ? i : -1);
1093       }
1094
1095       action[i] &= ~KEY_SET_FOCUS;
1096     }
1097   }
1098
1099   tape.delay_played++;
1100   if (tape.delay_played >= tape.pos[tape.counter].delay)
1101   {
1102     tape.counter++;
1103     tape.delay_played = 0;
1104   }
1105
1106   if (tape.auto_play)
1107     PrintTapeReplayProgress(FALSE);
1108
1109   if (options.tape_log_filename != NULL)
1110     WriteTapeLogfile(action);
1111
1112   return action;
1113 }
1114
1115 void TapeStop(void)
1116 {
1117   if (tape.pausing)
1118     TapeTogglePause(TAPE_TOGGLE_MANUAL);
1119
1120   TapeStopRecording();
1121   TapeStopPlaying();
1122
1123   DrawVideoDisplay(VIDEO_STATE_OFF, 0);
1124
1125   if (tape.date && tape.length)
1126   {
1127     DrawVideoDisplay(VIDEO_STATE_DATE_ON, tape.date);
1128     DrawVideoDisplay(VIDEO_STATE_TIME_ON, tape.length_seconds);
1129     DrawVideoDisplay(VIDEO_STATE_FRAME_ON, tape.length_frames);
1130   }
1131 }
1132
1133 static void TapeStopGameOrTape(boolean stop_game)
1134 {
1135   if (score_info_tape_play || (!tape.playing && stop_game))
1136     RequestQuitGame(FALSE);
1137   else
1138     TapeStop();
1139 }
1140
1141 void TapeStopGame(void)
1142 {
1143   if (game_status == GAME_MODE_MAIN)
1144     return;
1145
1146   TapeStopGameOrTape(TRUE);
1147 }
1148
1149 void TapeStopTape(void)
1150 {
1151   TapeStopGameOrTape(FALSE);
1152 }
1153
1154 unsigned int GetTapeLengthFrames(void)
1155 {
1156   unsigned int tape_length_frames = 0;
1157   int i;
1158
1159   if (TAPE_IS_EMPTY(tape))
1160     return 0;
1161
1162   for (i = 0; i < tape.length; i++)
1163     tape_length_frames += tape.pos[i].delay;
1164
1165   return tape_length_frames;
1166 }
1167
1168 unsigned int GetTapeLengthSeconds(void)
1169 {
1170   return (GetTapeLengthFrames() * GAME_FRAME_DELAY / 1000);
1171 }
1172
1173 static float GetTapeLengthSecondsFloat(void)
1174 {
1175   return ((float)GetTapeLengthFrames() * GAME_FRAME_DELAY / 1000);
1176 }
1177
1178 static void TapeStartWarpForward(int mode)
1179 {
1180   tape.fast_forward = (mode & AUTOPLAY_FFWD);
1181   tape.warp_forward = (mode & AUTOPLAY_WARP);
1182   tape.deactivate_display = (mode & AUTOPLAY_WARP_NO_DISPLAY);
1183
1184   tape.pausing = FALSE;
1185
1186   if (tape.deactivate_display)
1187     TapeDeactivateDisplayOn();
1188
1189   DrawVideoDisplayCurrentState();
1190 }
1191
1192 static void TapeStopWarpForward(void)
1193 {
1194   tape.fast_forward = FALSE;
1195   tape.warp_forward = FALSE;
1196   tape.deactivate_display = FALSE;
1197
1198   tape.pause_before_end = FALSE;
1199
1200   TapeDeactivateDisplayOff(game_status == GAME_MODE_PLAYING);
1201
1202   DrawVideoDisplayCurrentState();
1203 }
1204
1205 static void TapeSingleStep(void)
1206 {
1207   if (network.enabled)
1208     return;
1209
1210   if (!tape.pausing)
1211     TapeTogglePause(TAPE_TOGGLE_MANUAL);
1212
1213   tape.single_step = !tape.single_step;
1214
1215   DrawVideoDisplay(VIDEO_STATE_1STEP(tape.single_step), 0);
1216 }
1217
1218 void TapeQuickSave(void)
1219 {
1220   if (game_status != GAME_MODE_PLAYING)
1221   {
1222     Request("No game that could be saved!", REQ_CONFIRM);
1223
1224     return;
1225   }
1226
1227   if (!tape.recording)
1228   {
1229     Request("No recording that could be saved!", REQ_CONFIRM);
1230
1231     return;
1232   }
1233
1234   TapeHaltRecording();          // prepare tape for saving on-the-fly
1235
1236   if (TAPE_IS_EMPTY(tape))
1237   {
1238     Request("No tape that could be saved!", REQ_CONFIRM);
1239
1240     return;
1241   }
1242
1243   tape.property_bits |= TAPE_PROPERTY_SNAPSHOT;
1244
1245   if (SaveTapeChecked(tape.level_nr))
1246     SaveEngineSnapshotSingle();
1247 }
1248
1249 void TapeQuickLoad(void)
1250 {
1251   char *filename = getTapeFilename(level_nr);
1252
1253   if (!fileExists(filename))
1254   {
1255     Request("No tape for this level!", REQ_CONFIRM);
1256
1257     return;
1258   }
1259
1260   if (tape.recording && !Request("Stop recording and load tape?",
1261                                  REQ_ASK | REQ_STAY_CLOSED))
1262   {
1263     OpenDoor(DOOR_OPEN_1 | DOOR_COPY_BACK);
1264
1265     return;
1266   }
1267
1268   if (game_status != GAME_MODE_PLAYING && game_status != GAME_MODE_MAIN)
1269     return;
1270
1271   if (CheckEngineSnapshotSingle())
1272   {
1273     TapeStartGamePlaying();
1274
1275     LoadEngineSnapshotSingle();
1276
1277     DrawCompleteVideoDisplay();
1278
1279     tape.playing = TRUE;
1280     tape.pausing = TRUE;
1281
1282     TapeStopWarpForward();
1283     TapeAppendRecording();
1284
1285     // restart step/move snapshots after quick loading tape
1286     SaveEngineSnapshotToListInitial();
1287
1288     if (FrameCounter > 0)
1289       return;
1290   }
1291
1292   TapeStop();
1293   TapeErase();
1294
1295   LoadTape(level_nr);
1296
1297   if (!TAPE_IS_EMPTY(tape))
1298   {
1299     TapeStartGamePlaying();
1300     TapeStartWarpForward(AUTOPLAY_MODE_WARP_NO_DISPLAY);
1301
1302     tape.quick_resume = TRUE;
1303     tape.property_bits |= TAPE_PROPERTY_SNAPSHOT;
1304   }
1305   else  // this should not happen (basically checked above)
1306   {
1307     int reopen_door = (game_status == GAME_MODE_PLAYING ? REQ_REOPEN : 0);
1308
1309     Request("No tape for this level!", REQ_CONFIRM | reopen_door);
1310   }
1311 }
1312
1313 static boolean checkRestartGame(char *message)
1314 {
1315   if (game_status == GAME_MODE_MAIN)
1316     return TRUE;
1317
1318   if (!hasStartedNetworkGame())
1319     return FALSE;
1320
1321   if (level_editor_test_game)
1322     return TRUE;
1323
1324   if (game.all_players_gone)
1325     return TRUE;
1326
1327   if (!setup.ask_on_quit_game)
1328     return TRUE;
1329
1330   if (Request(message, REQ_ASK | REQ_STAY_CLOSED))
1331     return TRUE;
1332
1333   OpenDoor(DOOR_OPEN_1 | DOOR_COPY_BACK);
1334
1335   return FALSE;
1336 }
1337
1338 void TapeRestartGame(void)
1339 {
1340   if (score_info_tape_play)
1341   {
1342     TapeStartGamePlaying();
1343
1344     return;
1345   }
1346
1347   if (!checkRestartGame("Restart game?"))
1348     return;
1349
1350   StartGameActions(network.enabled, setup.autorecord, level.random_seed);
1351 }
1352
1353 void TapeReplayAndPauseBeforeEnd(void)
1354 {
1355   if (score_info_tape_play)
1356     return;
1357
1358   if (TAPE_IS_EMPTY(tape) && !tape.recording)
1359   {
1360     Request("No tape for this level!", REQ_CONFIRM);
1361
1362     return;
1363   }
1364
1365   if (!checkRestartGame("Replay game and pause before end?"))
1366     return;
1367
1368   TapeStop();
1369   TapeStartGamePlaying();
1370   TapeStartWarpForward(AUTOPLAY_MODE_WARP_NO_DISPLAY);
1371
1372   tape.pause_before_end = TRUE;
1373   tape.quick_resume = TRUE;
1374 }
1375
1376 boolean hasSolutionTape(void)
1377 {
1378   boolean tape_file_exists = fileExists(getSolutionTapeFilename(level_nr));
1379   boolean level_has_tape = (level.game_engine_type == GAME_ENGINE_TYPE_SP &&
1380                             level.native_sp_level->demo.is_available);
1381
1382   return (tape_file_exists || level_has_tape);
1383 }
1384
1385 boolean InsertSolutionTape(void)
1386 {
1387   if (!hasSolutionTape())
1388   {
1389     Request("No solution tape for this level!", REQ_CONFIRM);
1390
1391     return FALSE;
1392   }
1393
1394   if (!TAPE_IS_STOPPED(tape))
1395     TapeStop();
1396
1397   // if tape recorder already contains a tape, remove it without asking
1398   TapeErase();
1399
1400   LoadSolutionTape(level_nr);
1401
1402   DrawCompleteVideoDisplay();
1403
1404   if (TAPE_IS_EMPTY(tape))
1405   {
1406     Request("Loading solution tape for this level failed!", REQ_CONFIRM);
1407
1408     return FALSE;
1409   }
1410
1411   return TRUE;
1412 }
1413
1414 boolean PlaySolutionTape(void)
1415 {
1416   if (!InsertSolutionTape())
1417     return FALSE;
1418
1419   TapeStartGamePlaying();
1420
1421   return TRUE;
1422 }
1423
1424 static boolean PlayScoreTape_WaitForDownload(void)
1425 {
1426   DelayCounter download_delay = { 10000 };
1427
1428   ResetDelayCounter(&download_delay);
1429
1430   // wait for score tape to be successfully downloaded (and fail on timeout)
1431   while (!server_scores.tape_downloaded)
1432   {
1433     if (DelayReached(&download_delay))
1434       return FALSE;
1435
1436     UPDATE_BUSY_STATE_NOT_LOADING();
1437
1438     Delay(20);
1439   }
1440
1441   return TRUE;
1442 }
1443
1444 boolean PlayScoreTape(int entry_nr)
1445 {
1446   struct ScoreEntry *entry = &scores.entry[entry_nr];
1447   char *tape_filename =
1448     (entry->id == -1 ?
1449      getScoreTapeFilename(entry->tape_basename, level_nr) :
1450      getScoreCacheTapeFilename(entry->tape_basename, level_nr));
1451   boolean download_tape = (!fileExists(tape_filename));
1452
1453   if (download_tape && entry->id == -1)
1454   {
1455     FadeSkipNextFadeIn();
1456
1457     Request("Cannot find score tape!", REQ_CONFIRM);
1458
1459     return FALSE;
1460   }
1461
1462   server_scores.tape_downloaded = FALSE;
1463
1464   if (download_tape)
1465     ApiGetScoreTapeAsThread(level_nr, entry->id, entry->tape_basename);
1466
1467   SetGameStatus(GAME_MODE_PLAYING);
1468
1469   FadeOut(REDRAW_FIELD);
1470
1471   if (download_tape && !PlayScoreTape_WaitForDownload())
1472   {
1473     SetGameStatus(GAME_MODE_SCOREINFO);
1474     ClearField();
1475
1476     Request("Cannot download score tape from score server!", REQ_CONFIRM);
1477
1478     return FALSE;
1479   }
1480
1481   if (!TAPE_IS_STOPPED(tape))
1482     TapeStop();
1483
1484   // if tape recorder already contains a tape, remove it without asking
1485   TapeErase();
1486
1487   if (entry->id == -1)
1488     LoadScoreTape(entry->tape_basename, level_nr);
1489   else
1490     LoadScoreCacheTape(entry->tape_basename, level_nr);
1491
1492   if (TAPE_IS_EMPTY(tape))
1493   {
1494     SetGameStatus(GAME_MODE_SCOREINFO);
1495     ClearField();
1496
1497     Request("Cannot load score tape for this level!", REQ_CONFIRM);
1498
1499     return FALSE;
1500   }
1501
1502   FadeSkipNextFadeOut();
1503
1504   TapeStartGamePlaying();
1505
1506   score_info_tape_play = TRUE;
1507
1508   return TRUE;
1509 }
1510
1511 static boolean checkTapesFromSameLevel(struct TapeInfo *t1, struct TapeInfo *t2)
1512 {
1513   return (strEqual(t1->level_identifier, t2->level_identifier) &&
1514           t1->level_nr == t2->level_nr);
1515 }
1516
1517 static void CopyTape(struct TapeInfo *tape_from, struct TapeInfo *tape_to)
1518 {
1519   *tape_to = *tape_from;
1520 }
1521
1522 static void SwapTapes(struct TapeInfo *t1, struct TapeInfo *t2)
1523 {
1524   struct TapeInfo tmp = *t1;
1525
1526   *t1 = *t2;
1527   *t2 = tmp;
1528 }
1529
1530 static void CopyTapeToUndoBuffer(void)
1531 {
1532   // copy tapes to undo buffer if large enough (or larger than last undo tape)
1533   // or if the last undo tape is from a different level set or level number
1534   if (tape.length_seconds >= TAPE_MIN_SECONDS_FOR_UNDO_BUFFER ||
1535       tape.length_seconds >= tape_undo_buffer.length_seconds ||
1536       !checkTapesFromSameLevel(&tape, &tape_undo_buffer))
1537   {
1538     CopyTape(&tape, &tape_undo_buffer);
1539   }
1540 }
1541
1542 void UndoTape(void)
1543 {
1544   // only undo tapes from same level set and with same level number
1545   if (!checkTapesFromSameLevel(&tape, &tape_undo_buffer))
1546     return;
1547
1548   if (!TAPE_IS_STOPPED(tape))
1549     TapeStop();
1550
1551   // swap last recorded tape with undo buffer, so undo can be reversed
1552   SwapTapes(&tape, &tape_undo_buffer);
1553
1554   DrawCompleteVideoDisplay();
1555 }
1556
1557 void FixTape_ForceSinglePlayer(void)
1558 {
1559   int i;
1560
1561   /* fix single-player tapes that contain player input for more than one
1562      player (due to a bug in 3.3.1.2 and earlier versions), which results
1563      in playing levels with more than one player in multi-player mode,
1564      even though the tape was originally recorded in single-player mode */
1565
1566   // remove player input actions for all players but the first one
1567   for (i = 1; i < MAX_PLAYERS; i++)
1568     tape.player_participates[i] = FALSE;
1569
1570   tape.changed = TRUE;
1571 }
1572
1573
1574 // ----------------------------------------------------------------------------
1575 // tape autoplay functions
1576 // ----------------------------------------------------------------------------
1577
1578 static TreeInfo *getNextValidAutoPlayEntry(TreeInfo *node)
1579 {
1580   node = getNextValidTreeInfoEntry(node);
1581
1582   while (node && node->is_copy)
1583     node = getNextValidTreeInfoEntry(node);
1584
1585   return node;
1586 }
1587
1588 static TreeInfo *getFirstValidAutoPlayEntry(TreeInfo *node)
1589 {
1590   node = getFirstValidTreeInfoEntry(node);
1591
1592   if (node && node->is_copy)
1593     return getNextValidAutoPlayEntry(node);
1594
1595   return node;
1596 }
1597
1598 static void AutoPlayTapes_SetScoreEntry(int score, int time)
1599 {
1600   char *name = (options.mytapes ? setup.player_name : options.player_name);
1601
1602   // set unique basename for score tape (for uploading to score server)
1603   strcpy(tape.score_tape_basename, getScoreTapeBasename(name));
1604
1605   // store score in first score entry
1606   scores.last_added = 0;
1607
1608   struct ScoreEntry *entry = &scores.entry[scores.last_added];
1609
1610   strncpy(entry->tape_basename, tape.score_tape_basename, MAX_FILENAME_LEN);
1611   strncpy(entry->name, setup.player_name, MAX_PLAYER_NAME_LEN);
1612
1613   entry->score = score;
1614   entry->time = time;
1615
1616   PrintNoLog("- uploading score tape to score server ... ");
1617
1618   server_scores.uploaded = FALSE;
1619 }
1620
1621 static boolean AutoPlayTapes_WaitForUpload(void)
1622 {
1623   DelayCounter upload_delay = { 10000 };
1624
1625   ResetDelayCounter(&upload_delay);
1626
1627   // wait for score tape to be successfully uploaded (and fail on timeout)
1628   while (!server_scores.uploaded)
1629   {
1630     if (DelayReached(&upload_delay))
1631     {
1632       PrintNoLog("\r");
1633       Print("- uploading score tape to score server - TIMEOUT.\n");
1634
1635       if (program.headless)
1636         Fail("cannot upload score tape to score server");
1637
1638       return FALSE;
1639     }
1640
1641     UPDATE_BUSY_STATE();
1642
1643     Delay(20);
1644   }
1645
1646   PrintNoLog("\r");
1647   Print("- uploading score tape to score server - uploaded.\n");
1648
1649   return TRUE;
1650 }
1651
1652 static int AutoPlayTapesExt(boolean initialize)
1653 {
1654   static struct AutoPlayInfo autoplay;
1655   static int num_tapes = 0;
1656   static int patch_nr = 0;
1657   static char *patch_name[] =
1658   {
1659     "original tape",
1660     "em_random_bug",
1661     "screen_34x34",
1662
1663     NULL
1664   };
1665   static int patch_version_first[] =
1666   {
1667     VERSION_IDENT(0,0,0,0),
1668     VERSION_IDENT(3,3,1,0),
1669     VERSION_IDENT(0,0,0,0),
1670
1671     -1
1672   };
1673   static int patch_version_last[] =
1674   {
1675     VERSION_IDENT(9,9,9,9),
1676     VERSION_IDENT(4,0,1,1),
1677     VERSION_IDENT(4,2,2,0),
1678
1679     -1
1680   };
1681   static byte patch_property_bit[] =
1682   {
1683     TAPE_PROPERTY_NONE,
1684     TAPE_PROPERTY_EM_RANDOM_BUG,
1685     TAPE_PROPERTY_NONE,
1686
1687     -1
1688   };
1689   LevelDirTree *leveldir_current_last = leveldir_current;
1690   boolean init_level_set = FALSE;
1691   int level_nr_last = level_nr;
1692   int i;
1693
1694   if (!initialize)
1695   {
1696     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1697     {
1698       if (tape.auto_play_level_solved)
1699       {
1700         if (patch_nr > 0)
1701         {
1702           // level solved by patched tape -- save fixed tape
1703           char *filename = getTapeFilename(level_nr);
1704           char *filename_orig = getStringCat2(filename, ".orig");
1705
1706           // create backup from old tape, if not yet existing
1707           if (!fileExists(filename_orig))
1708             rename(filename, filename_orig);
1709
1710           SaveTapeToFilename(filename);
1711
1712           tape.auto_play_level_fixed = TRUE;
1713           autoplay.num_tapes_patched++;
1714         }
1715
1716         // continue with next tape
1717         patch_nr = 0;
1718       }
1719       else if (patch_name[patch_nr + 1] != NULL)
1720       {
1721         // level not solved by patched tape -- continue with next patch
1722         patch_nr++;
1723       }
1724       else
1725       {
1726         // level not solved by any patched tape -- continue with next tape
1727         tape.auto_play_level_not_fixable = TRUE;
1728         patch_nr = 0;
1729       }
1730     }
1731
1732     // just finished auto-playing tape
1733     PrintTapeReplayProgress(TRUE);
1734
1735     if (options.tape_log_filename != NULL)
1736       CloseTapeLogfile();
1737
1738     if (global.autoplay_mode == AUTOPLAY_MODE_SAVE &&
1739         tape.auto_play_level_solved)
1740     {
1741       AutoPlayTapes_SetScoreEntry(game.score_final, game.score_time_final);
1742
1743       if (leveldir_current)
1744       {
1745         // the tape's level set identifier may differ from current level set
1746         strncpy(tape.level_identifier, leveldir_current->identifier,
1747                 MAX_FILENAME_LEN);
1748         tape.level_identifier[MAX_FILENAME_LEN] = '\0';
1749
1750         // the tape's level number may differ from current level number
1751         tape.level_nr = level_nr;
1752       }
1753
1754       // save score tape to upload to server; may be required for some reasons:
1755       // * level set identifier in solution tapes may differ from level set
1756       // * level set identifier is missing (old-style tape without INFO chunk)
1757       // * solution tape may have native format (like Supaplex solution files)
1758
1759       SaveScoreTape(level_nr);
1760       SaveServerScore(level_nr, TRUE);
1761
1762       AutoPlayTapes_WaitForUpload();
1763     }
1764
1765     if (patch_nr == 0)
1766       autoplay.num_levels_played++;
1767
1768     if (tape.auto_play_level_solved)
1769       autoplay.num_levels_solved++;
1770
1771     if (level_nr >= 0 && level_nr < MAX_TAPES_PER_SET)
1772       autoplay.level_failed[level_nr] = !tape.auto_play_level_solved;
1773   }
1774   else
1775   {
1776     if (strEqual(global.autoplay_leveldir, "ALL"))
1777     {
1778       autoplay.all_levelsets = TRUE;
1779
1780       // tape mass-uploading only allowed for private tapes
1781       if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
1782         options.mytapes = TRUE;
1783     }
1784
1785     if ((global.autoplay_mode == AUTOPLAY_MODE_SAVE ||
1786          global.autoplay_mode == AUTOPLAY_MODE_UPLOAD) &&
1787         !options.mytapes &&
1788         options.player_name == NULL)
1789     {
1790       Fail("specify player name when uploading solution tapes");
1791     }
1792
1793     if (global.autoplay_mode != AUTOPLAY_MODE_UPLOAD)
1794       DrawCompleteVideoDisplay();
1795
1796     if (program.headless)
1797     {
1798       audio.sound_enabled = FALSE;
1799       setup.engine_snapshot_mode = getStringCopy(STR_SNAPSHOT_MODE_OFF);
1800     }
1801
1802     if (strSuffix(global.autoplay_leveldir, ".tape"))
1803     {
1804       autoplay.tape_filename = global.autoplay_leveldir;
1805
1806       if (!fileExists(autoplay.tape_filename))
1807         Fail("tape file '%s' does not exist", autoplay.tape_filename);
1808
1809       LoadTapeFromFilename(autoplay.tape_filename);
1810
1811       if (tape.no_valid_file)
1812         Fail("cannot load tape file '%s'", autoplay.tape_filename);
1813
1814       if (tape.no_info_chunk && !options.identifier)
1815         Fail("cannot get levelset from tape file '%s'", autoplay.tape_filename);
1816
1817       if (tape.no_info_chunk && !options.level_nr)
1818         Fail("cannot get level nr from tape file '%s'", autoplay.tape_filename);
1819
1820       global.autoplay_leveldir = tape.level_identifier;
1821
1822       if (options.identifier != NULL)
1823         global.autoplay_leveldir = options.identifier;
1824
1825       if (options.level_nr != NULL)
1826         tape.level_nr = atoi(options.level_nr);
1827
1828       if (tape.level_nr >= 0 && tape.level_nr < MAX_TAPES_PER_SET)
1829         global.autoplay_level[tape.level_nr] = TRUE;
1830
1831       global.autoplay_all = FALSE;
1832       options.mytapes = FALSE;
1833     }
1834
1835     if (autoplay.all_levelsets)
1836     {
1837       // start auto-playing first level set
1838       autoplay.leveldir = getFirstValidAutoPlayEntry(leveldir_first);
1839     }
1840     else
1841     {
1842       // auto-play selected level set
1843       autoplay.leveldir = getTreeInfoFromIdentifier(leveldir_first,
1844                                                     global.autoplay_leveldir);
1845     }
1846
1847     if (autoplay.leveldir == NULL)
1848       Fail("no such level identifier: '%s'", global.autoplay_leveldir);
1849
1850     // only private tapes may be modified
1851     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1852       options.mytapes = TRUE;
1853
1854     // set timestamp for batch tape upload
1855     global.autoplay_time = time(NULL);
1856
1857     num_tapes = 0;
1858
1859     init_level_set = TRUE;
1860   }
1861
1862   while (1)
1863   {
1864     if (init_level_set)
1865     {
1866       leveldir_current = autoplay.leveldir;
1867
1868       if (autoplay.leveldir->first_level < 0)
1869         autoplay.leveldir->first_level = 0;
1870       if (autoplay.leveldir->last_level >= MAX_TAPES_PER_SET)
1871         autoplay.leveldir->last_level = MAX_TAPES_PER_SET - 1;
1872
1873       autoplay.level_nr = autoplay.leveldir->first_level;
1874
1875       autoplay.num_levels_played = 0;
1876       autoplay.num_levels_solved = 0;
1877       autoplay.num_tapes_patched = 0;
1878       autoplay.num_tape_missing = 0;
1879
1880       for (i = 0; i < MAX_TAPES_PER_SET; i++)
1881         autoplay.level_failed[i] = FALSE;
1882
1883       PrintTapeReplayHeader(&autoplay);
1884
1885       init_level_set = FALSE;
1886     }
1887
1888     if (autoplay.all_levelsets && global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
1889     {
1890       boolean skip_levelset = FALSE;
1891
1892       if (!directoryExists(getTapeDir(autoplay.leveldir->subdir)))
1893       {
1894         Print("No tape directory for this level set found -- skipping.\n");
1895
1896         skip_levelset = TRUE;
1897       }
1898
1899       if (CheckTapeDirectoryUploadsComplete(autoplay.leveldir->subdir))
1900       {
1901         Print("All tapes for this level set already uploaded -- skipping.\n");
1902
1903         skip_levelset = TRUE;
1904       }
1905
1906       if (skip_levelset)
1907       {
1908         PrintTapeReplaySummary(&autoplay);
1909
1910         // continue with next level set
1911         autoplay.leveldir = getNextValidAutoPlayEntry(autoplay.leveldir);
1912
1913         // all level sets processed
1914         if (autoplay.leveldir == NULL)
1915           break;
1916
1917         init_level_set = TRUE;
1918
1919         continue;
1920       }
1921     }
1922
1923     if (global.autoplay_mode != AUTOPLAY_MODE_FIX || patch_nr == 0)
1924       level_nr = autoplay.level_nr++;
1925
1926     UPDATE_BUSY_STATE();
1927
1928     // check if all tapes for this level set have been processed
1929     if (level_nr > autoplay.leveldir->last_level)
1930     {
1931       PrintTapeReplaySummary(&autoplay);
1932
1933       if (!autoplay.all_levelsets)
1934         break;
1935
1936       if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
1937         MarkTapeDirectoryUploadsAsComplete(autoplay.leveldir->subdir);
1938
1939       // continue with next level set
1940       autoplay.leveldir = getNextValidAutoPlayEntry(autoplay.leveldir);
1941
1942       // all level sets processed
1943       if (autoplay.leveldir == NULL)
1944         break;
1945
1946       init_level_set = TRUE;
1947
1948       continue;
1949     }
1950
1951     // set patch info (required for progress output)
1952     strcpy(tape_patch_info, "");
1953     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1954       snprintf(tape_patch_info, MAX_OUTPUT_LINESIZE, "[%-13s] ",
1955                patch_name[patch_nr]);
1956
1957     if (!global.autoplay_all && !global.autoplay_level[level_nr])
1958       continue;
1959
1960     // speed things up in case of missing private tapes (skip loading level)
1961     if (options.mytapes && !fileExists(getTapeFilename(level_nr)))
1962     {
1963       autoplay.num_tape_missing++;
1964
1965       Print("Tape %03d: (no tape found)\n", level_nr);
1966
1967       continue;
1968     }
1969
1970     TapeErase();
1971     TapeRewind();       // needed to reset "tape.auto_play_level_solved"
1972
1973     LoadLevel(level_nr);
1974
1975     if (level.no_level_file || level.no_valid_file)
1976     {
1977       Print("Tape %03d: (no level found)\n", level_nr);
1978
1979       continue;
1980     }
1981
1982 #if 0
1983     // ACTIVATE THIS FOR LOADING/TESTING OF LEVELS ONLY
1984     Print("Tape %03d: (only testing level)\n", level_nr);
1985     continue;
1986 #endif
1987
1988     if (autoplay.tape_filename)
1989       LoadTapeFromFilename(autoplay.tape_filename);
1990     else if (options.mytapes)
1991       LoadTape(level_nr);
1992     else
1993       LoadSolutionTape(level_nr);
1994
1995     if (tape.no_valid_file)
1996     {
1997       autoplay.num_tape_missing++;
1998
1999       Print("Tape %03d: (no tape found)\n", level_nr);
2000
2001       continue;
2002     }
2003
2004     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
2005     {
2006       boolean skip_patch = FALSE;
2007
2008       if (tape.engine_version < patch_version_first[patch_nr] ||
2009           tape.engine_version > patch_version_last[patch_nr])
2010       {
2011         Print("Tape %03d %s[%02d:%02d]: (%s %d.%d.%d.%d) - skipped.\n",
2012               level_nr,  tape_patch_info,
2013               tape.length_seconds / 60, tape.length_seconds % 60,
2014               "not suitable for version",
2015               (tape.engine_version / 1000000) % 100,
2016               (tape.engine_version / 10000  ) % 100,
2017               (tape.engine_version / 100    ) % 100,
2018               (tape.engine_version          ) % 100);
2019
2020         skip_patch = TRUE;
2021       }
2022
2023       if (strEqual(patch_name[patch_nr], "screen_34x34") &&
2024           tape.num_participating_players == 1)
2025       {
2026         Print("Tape %03d %s[%02d:%02d]: (%s) - skipped.\n",
2027               level_nr,  tape_patch_info,
2028               tape.length_seconds / 60, tape.length_seconds % 60,
2029               "not suitable for single player tapes");
2030
2031         skip_patch = TRUE;
2032       }
2033
2034       if (skip_patch)
2035       {
2036         if (patch_name[patch_nr + 1] != NULL)
2037         {
2038           // continue with next patch
2039           patch_nr++;
2040         }
2041         else
2042         {
2043           // continue with next tape
2044           patch_nr = 0;
2045         }
2046
2047         continue;
2048       }
2049
2050       if (strEqual(patch_name[patch_nr], "screen_34x34"))
2051       {
2052         tape.scr_fieldx = SCR_FIELDX_DEFAULT * 2;
2053         tape.scr_fieldy = SCR_FIELDY_DEFAULT * 2;
2054       }
2055       else
2056       {
2057         tape.property_bits |= patch_property_bit[patch_nr];
2058       }
2059     }
2060
2061     num_tapes++;
2062
2063     if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
2064     {
2065       boolean use_temporary_tape_file = FALSE;
2066
2067       Print("Tape %03d:\n", level_nr);
2068
2069       AutoPlayTapes_SetScoreEntry(0, 0);
2070
2071       if (autoplay.tape_filename == NULL)
2072       {
2073         autoplay.tape_filename = (options.mytapes ? getTapeFilename(level_nr) :
2074                                   getDefaultSolutionTapeFilename(level_nr));
2075
2076         if (!fileExists(autoplay.tape_filename))
2077         {
2078           // non-standard or incorrect solution tape -- save to temporary file
2079           autoplay.tape_filename = getTemporaryTapeFilename();
2080
2081           SaveTapeToFilename(autoplay.tape_filename);
2082
2083           use_temporary_tape_file = TRUE;
2084         }
2085       }
2086
2087       SaveServerScoreFromFile(level_nr, TRUE, autoplay.tape_filename);
2088
2089       boolean success = AutoPlayTapes_WaitForUpload();
2090
2091       if (use_temporary_tape_file)
2092         unlink(autoplay.tape_filename);
2093
2094       // required for uploading multiple tapes
2095       autoplay.tape_filename = NULL;
2096
2097       if (!success)
2098       {
2099         num_tapes = -num_tapes;
2100
2101         break;
2102       }
2103
2104       continue;
2105     }
2106
2107     InitCounter();
2108
2109     if (options.tape_log_filename != NULL)
2110       OpenTapeLogfile();
2111
2112     TapeStartGamePlaying();
2113     TapeStartWarpForward(global.autoplay_mode);
2114
2115     autoplay.last_level_nr = level_nr;
2116
2117     return num_tapes;
2118   }
2119
2120   if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
2121   {
2122     Print("\n");
2123     PrintLine("=", 79);
2124
2125     if (num_tapes >= 0)
2126       Print("SUMMARY: %d tapes uploaded.\n", num_tapes);
2127     else
2128       Print("SUMMARY: Uploading tapes failed.\n");
2129
2130     PrintLine("=", 79);
2131   }
2132
2133   // clear timestamp for batch tape upload (required after interactive upload)
2134   global.autoplay_time = 0;
2135
2136   // exit if running headless or if visually auto-playing tapes
2137   if (program.headless || global.autoplay_mode != AUTOPLAY_MODE_UPLOAD)
2138     CloseAllAndExit(0);
2139
2140   // when running interactively, restore last selected level set and number
2141   leveldir_current = leveldir_current_last;
2142   level_nr = level_nr_last;
2143
2144   return num_tapes;
2145 }
2146
2147 int AutoPlayTapes(void)
2148 {
2149   return AutoPlayTapesExt(TRUE);
2150 }
2151
2152 int AutoPlayTapesContinue(void)
2153 {
2154   return AutoPlayTapesExt(FALSE);
2155 }
2156
2157
2158 // ----------------------------------------------------------------------------
2159 // tape patch functions
2160 // ----------------------------------------------------------------------------
2161
2162 static boolean PatchTape(struct TapeInfo *tape, char *mode)
2163 {
2164   Print("[%d.%d.%d.%d]: ",
2165         (tape->engine_version / 1000000) % 100,
2166         (tape->engine_version / 10000  ) % 100,
2167         (tape->engine_version / 100    ) % 100,
2168         (tape->engine_version          ) % 100);
2169
2170   if (strEqual(mode, "info"))
2171   {
2172     Print("property bits == 0x%02x\n", tape->property_bits);
2173
2174     return FALSE;
2175   }
2176
2177   boolean unpatch_tape = FALSE;
2178   boolean use_property_bit = FALSE;
2179   byte property_bitmask = 0;
2180
2181   if (strSuffix(mode, ":0") ||
2182       strSuffix(mode, ":off") ||
2183       strSuffix(mode, ":clear"))
2184     unpatch_tape = TRUE;
2185
2186   if (strEqual(mode, "em_random_bug") || strPrefix(mode, "em_random_bug:"))
2187   {
2188     // this bug was introduced in version 3.3.1.0 and fixed in version 4.0.1.2
2189     if (tape->engine_version <  VERSION_IDENT(3,3,1,0) ||
2190         tape->engine_version >= VERSION_IDENT(4,0,1,2))
2191     {
2192       Print("This tape version cannot be patched against EM random bug!\n");
2193
2194       return FALSE;
2195     }
2196
2197     property_bitmask = TAPE_PROPERTY_EM_RANDOM_BUG;
2198
2199     use_property_bit = TRUE;
2200   }
2201   else if (strEqual(mode, "screen_34x34") || strPrefix(mode, "screen_34x34:"))
2202   {
2203     // this bug only affects team mode tapes
2204     if (tape->num_participating_players == 1)
2205     {
2206       Print("Only team mode tapes can be patched against screen size bug!\n");
2207
2208       return FALSE;
2209     }
2210
2211     // this bug (that always existed before) was fixed in version 4.2.2.1
2212     if (tape->engine_version >= VERSION_IDENT(4,2,2,1))
2213     {
2214       Print("This tape version cannot be patched against screen size bug!\n");
2215
2216       return FALSE;
2217     }
2218
2219     int factor = (unpatch_tape ? 1 : 2);
2220     int scr_fieldx_new = SCR_FIELDX_DEFAULT * factor;
2221     int scr_fieldy_new = SCR_FIELDY_DEFAULT * factor;
2222
2223     if (scr_fieldx_new == tape->scr_fieldx &&
2224         scr_fieldy_new == tape->scr_fieldy)
2225     {
2226       Print("Tape already patched for '%s'!\n", mode);
2227
2228       return FALSE;
2229     }
2230
2231     tape->scr_fieldx = scr_fieldx_new;
2232     tape->scr_fieldy = scr_fieldy_new;
2233   }
2234   else
2235   {
2236     Print("Unknown patch mode '%s'!\n", mode);
2237
2238     return FALSE;
2239   }
2240
2241   // patching tapes using property bits may be used for several patch modes
2242   if (use_property_bit)
2243   {
2244     byte property_bits = tape->property_bits;
2245     boolean set_property_bit = (unpatch_tape ? FALSE : TRUE);
2246
2247     if (set_property_bit)
2248       property_bits |= property_bitmask;
2249     else
2250       property_bits &= ~property_bitmask;
2251
2252     if (property_bits == tape->property_bits)
2253     {
2254       Print("Tape already patched for '%s'!\n", mode);
2255
2256       return FALSE;
2257     }
2258
2259     tape->property_bits = property_bits;
2260   }
2261
2262   Print("Patching for '%s' ... ", mode);
2263
2264   return TRUE;
2265 }
2266
2267 void PatchTapes(void)
2268 {
2269   static LevelDirTree *patchtapes_leveldir = NULL;
2270   static int num_tapes_found = 0;
2271   static int num_tapes_patched = 0;
2272   char *mode = global.patchtapes_mode;
2273   int i;
2274
2275   if (strEqual(mode, "help"))
2276   {
2277     PrintLine("=", 79);
2278     Print("Supported patch modes:\n");
2279     Print("- \"em_random_bug\"   - use 64-bit random value bug for EM engine\n");
2280     Print("- \"screen_34x34\"    - force visible playfield size of 34 x 34\n");
2281     PrintLine("-", 79);
2282     Print("Supported modifiers:\n");
2283     Print("- add \":0\", \":off\" or \":clear\" to patch mode to un-patch tape file\n");
2284     PrintLine("=", 79);
2285
2286     CloseAllAndExit(0);
2287   }
2288
2289   patchtapes_leveldir = getTreeInfoFromIdentifier(leveldir_first,
2290                                                   global.patchtapes_leveldir);
2291
2292   if (patchtapes_leveldir == NULL)
2293     Fail("no such level identifier: '%s'", global.patchtapes_leveldir);
2294
2295   leveldir_current = patchtapes_leveldir;
2296
2297   if (patchtapes_leveldir->first_level < 0)
2298     patchtapes_leveldir->first_level = 0;
2299   if (patchtapes_leveldir->last_level >= MAX_TAPES_PER_SET)
2300     patchtapes_leveldir->last_level = MAX_TAPES_PER_SET - 1;
2301
2302   PrintLine("=", 79);
2303   Print("Patching level tapes for patch mode '%s'\n", mode);
2304   PrintLine("-", 79);
2305   Print("Level series identifier: '%s'\n", patchtapes_leveldir->identifier);
2306   Print("Level series name:       '%s'\n", patchtapes_leveldir->name);
2307   Print("Level series author:     '%s'\n", patchtapes_leveldir->author);
2308   Print("Number of levels:        %d\n",   patchtapes_leveldir->levels);
2309   PrintLine("=", 79);
2310   Print("\n");
2311
2312   int first_level = patchtapes_leveldir->first_level;
2313   int last_level = patchtapes_leveldir->last_level;
2314
2315   for (i = first_level; i <= last_level; i++)
2316   {
2317     if (!global.patchtapes_all && !global.patchtapes_level[i])
2318       continue;
2319
2320     Print("Tape %03d: ", i);
2321
2322     TapeErase();
2323     LoadTape(i);
2324
2325     if (tape.no_valid_file)
2326     {
2327       Print("(no tape found)\n");
2328
2329       continue;
2330     }
2331
2332     num_tapes_found++;
2333
2334     if (PatchTape(&tape, mode))
2335     {
2336       char *filename = getTapeFilename(i);
2337       char *filename_orig = getStringCat2(filename, ".orig");
2338
2339       if (!fileExists(filename_orig))
2340         rename(filename, filename_orig);
2341
2342       SaveTapeToFilename(filename);
2343
2344       Print("patched tape saved.\n");
2345
2346       num_tapes_patched++;
2347     }
2348   }
2349
2350   Print("\n");
2351   PrintLine("=", 79);
2352   Print("Number of tapes found: %d\n", num_tapes_found);
2353   Print("Number of tapes patched: %d\n", num_tapes_patched);
2354   PrintLine("=", 79);
2355
2356   CloseAllAndExit(0);
2357 }
2358
2359
2360 // ---------- new tape button stuff -------------------------------------------
2361
2362 static struct
2363 {
2364   int graphic;
2365   struct XY *pos;
2366   int gadget_id;
2367   char *infotext;
2368 } tapebutton_info[NUM_TAPE_BUTTONS] =
2369 {
2370   {
2371     IMG_GFX_TAPE_BUTTON_EJECT,          &tape.button.eject,
2372     TAPE_CTRL_ID_EJECT,                 "eject tape"
2373   },
2374   {
2375     // (same position as "eject" button)
2376     IMG_GFX_TAPE_BUTTON_EXTRA,          &tape.button.eject,
2377     TAPE_CTRL_ID_EXTRA,                 "extra functions"
2378   },
2379   {
2380     IMG_GFX_TAPE_BUTTON_STOP,           &tape.button.stop,
2381     TAPE_CTRL_ID_STOP,                  "stop tape"
2382   },
2383   {
2384     IMG_GFX_TAPE_BUTTON_PAUSE,          &tape.button.pause,
2385     TAPE_CTRL_ID_PAUSE,                 "pause tape"
2386   },
2387   {
2388     IMG_GFX_TAPE_BUTTON_RECORD,         &tape.button.record,
2389     TAPE_CTRL_ID_RECORD,                "record tape"
2390   },
2391   {
2392     IMG_GFX_TAPE_BUTTON_PLAY,           &tape.button.play,
2393     TAPE_CTRL_ID_PLAY,                  "play tape"
2394   },
2395   {
2396     IMG_GFX_TAPE_BUTTON_INSERT_SOLUTION,&tape.button.insert_solution,
2397     TAPE_CTRL_ID_INSERT_SOLUTION,       "insert solution tape"
2398   },
2399   {
2400     IMG_GFX_TAPE_BUTTON_PLAY_SOLUTION,  &tape.button.play_solution,
2401     TAPE_CTRL_ID_PLAY_SOLUTION,         "play solution tape"
2402   }
2403 };
2404
2405 void CreateTapeButtons(void)
2406 {
2407   int i;
2408
2409   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2410   {
2411     int graphic = tapebutton_info[i].graphic;
2412     struct GraphicInfo *gfx = &graphic_info[graphic];
2413     struct XY *pos = tapebutton_info[i].pos;
2414     struct GadgetInfo *gi;
2415     int gd_x = gfx->src_x;
2416     int gd_y = gfx->src_y;
2417     int gd_xp = gfx->src_x + gfx->pressed_xoffset;
2418     int gd_yp = gfx->src_y + gfx->pressed_yoffset;
2419     int id = i;
2420
2421     gi = CreateGadget(GDI_CUSTOM_ID, id,
2422                       GDI_IMAGE_ID, graphic,
2423                       GDI_INFO_TEXT, tapebutton_info[i].infotext,
2424                       GDI_X, VX + pos->x,
2425                       GDI_Y, VY + pos->y,
2426                       GDI_WIDTH, gfx->width,
2427                       GDI_HEIGHT, gfx->height,
2428                       GDI_TYPE, GD_TYPE_NORMAL_BUTTON,
2429                       GDI_STATE, GD_BUTTON_UNPRESSED,
2430                       GDI_DESIGN_UNPRESSED, gfx->bitmap, gd_x, gd_y,
2431                       GDI_DESIGN_PRESSED, gfx->bitmap, gd_xp, gd_yp,
2432                       GDI_DIRECT_DRAW, FALSE,
2433                       GDI_EVENT_MASK, GD_EVENT_RELEASED,
2434                       GDI_CALLBACK_ACTION, HandleTapeButtons,
2435                       GDI_END);
2436
2437     if (gi == NULL)
2438       Fail("cannot create gadget");
2439
2440     tape_gadget[id] = gi;
2441   }
2442 }
2443
2444 void FreeTapeButtons(void)
2445 {
2446   int i;
2447
2448   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2449     FreeGadget(tape_gadget[i]);
2450 }
2451
2452 void MapTapeEjectButton(void)
2453 {
2454   UnmapGadget(tape_gadget[TAPE_CTRL_ID_EXTRA]);
2455   MapGadget(tape_gadget[TAPE_CTRL_ID_EJECT]);
2456 }
2457
2458 void MapTapeWarpButton(void)
2459 {
2460   UnmapGadget(tape_gadget[TAPE_CTRL_ID_EJECT]);
2461   MapGadget(tape_gadget[TAPE_CTRL_ID_EXTRA]);
2462 }
2463
2464 void MapTapeButtons(void)
2465 {
2466   int i;
2467
2468   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2469     if (i != TAPE_CTRL_ID_EXTRA)
2470       MapGadget(tape_gadget[i]);
2471
2472   if (tape.recording || tape.playing)
2473     MapTapeWarpButton();
2474
2475   if (tape.show_game_buttons)
2476     MapGameButtonsOnTape();
2477 }
2478
2479 void UnmapTapeButtons(void)
2480 {
2481   int i;
2482
2483   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2484     UnmapGadget(tape_gadget[i]);
2485
2486   if (tape.show_game_buttons)
2487     UnmapGameButtonsOnTape();
2488 }
2489
2490 void RedrawTapeButtons(void)
2491 {
2492   int i;
2493
2494   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2495     RedrawGadget(tape_gadget[i]);
2496
2497   if (tape.show_game_buttons)
2498     RedrawGameButtonsOnTape();
2499 }
2500
2501 void RedrawOrRemapTapeButtons(void)
2502 {
2503   if (tape_gadget[TAPE_CTRL_ID_PLAY]->mapped)
2504   {
2505     // tape buttons already mapped
2506     RedrawTapeButtons();
2507   }
2508   else
2509   {
2510     UnmapTapeButtons();
2511     MapTapeButtons();
2512   }
2513 }
2514
2515 static void HandleTapeButtonsExt(int id)
2516 {
2517   if (game_status != GAME_MODE_MAIN && game_status != GAME_MODE_PLAYING)
2518     return;
2519
2520   switch (id)
2521   {
2522     case TAPE_CTRL_ID_EJECT:
2523       TapeStop();
2524
2525       if (TAPE_IS_EMPTY(tape))
2526       {
2527         LoadTape(level_nr);
2528
2529         if (TAPE_IS_EMPTY(tape))
2530           Request("No tape for this level!", REQ_CONFIRM);
2531       }
2532       else
2533       {
2534         if (tape.changed)
2535           SaveTapeChecked(level_nr);
2536
2537         TapeErase();
2538       }
2539
2540       DrawCompleteVideoDisplay();
2541       break;
2542
2543     case TAPE_CTRL_ID_EXTRA:
2544       if (tape.playing)
2545       {
2546         tape.pause_before_end = !tape.pause_before_end;
2547
2548         DrawVideoDisplayCurrentState();
2549       }
2550       else if (tape.recording)
2551       {
2552         TapeSingleStep();
2553       }
2554
2555       break;
2556
2557     case TAPE_CTRL_ID_STOP:
2558       TapeStopTape();
2559
2560       break;
2561
2562     case TAPE_CTRL_ID_PAUSE:
2563       TapeTogglePause(TAPE_TOGGLE_MANUAL);
2564
2565       break;
2566
2567     case TAPE_CTRL_ID_RECORD:
2568       if (TAPE_IS_STOPPED(tape))
2569       {
2570         TapeStartGameRecording();
2571       }
2572       else if (tape.pausing)
2573       {
2574         if (tape.playing)                       // PLAY -> PAUSE -> RECORD
2575           TapeAppendRecording();
2576         else
2577           TapeTogglePause(TAPE_TOGGLE_MANUAL);
2578       }
2579
2580       break;
2581
2582     case TAPE_CTRL_ID_PLAY:
2583       if (tape.recording && tape.pausing)       // PAUSE -> RECORD
2584       {
2585         // ("TAPE_IS_EMPTY(tape)" is TRUE here -- probably fix this)
2586
2587         TapeTogglePause(TAPE_TOGGLE_MANUAL);
2588       }
2589
2590       if (TAPE_IS_EMPTY(tape))
2591         break;
2592
2593       if (TAPE_IS_STOPPED(tape))
2594       {
2595         TapeStartGamePlaying();
2596       }
2597       else if (tape.playing)
2598       {
2599         if (tape.pausing)                       // PAUSE -> PLAY
2600         {
2601           TapeTogglePause(TAPE_TOGGLE_MANUAL | TAPE_TOGGLE_PLAY_PAUSE);
2602         }
2603         else if (!tape.fast_forward)            // PLAY -> FFWD
2604         {
2605           tape.fast_forward = TRUE;
2606         }
2607         else if (!tape.warp_forward)            // FFWD -> WARP
2608         {
2609           tape.warp_forward = TRUE;
2610         }
2611         else if (!tape.deactivate_display)      // WARP -> WARP BLIND
2612         {
2613           tape.deactivate_display = TRUE;
2614
2615           TapeDeactivateDisplayOn();
2616         }
2617         else                                    // WARP BLIND -> PLAY
2618         {
2619           tape.fast_forward = FALSE;
2620           tape.warp_forward = FALSE;
2621           tape.deactivate_display = FALSE;
2622
2623           TapeDeactivateDisplayOff(game_status == GAME_MODE_PLAYING);
2624         }
2625
2626         DrawVideoDisplayCurrentState();
2627       }
2628
2629       break;
2630
2631     case TAPE_CTRL_ID_INSERT_SOLUTION:
2632       InsertSolutionTape();
2633
2634       break;
2635
2636     case TAPE_CTRL_ID_PLAY_SOLUTION:
2637       PlaySolutionTape();
2638
2639       break;
2640
2641     default:
2642       break;
2643   }
2644 }
2645
2646 static void HandleTapeButtons(struct GadgetInfo *gi)
2647 {
2648   HandleTapeButtonsExt(gi->custom_id);
2649 }
2650
2651 void HandleTapeButtonKeys(Key key)
2652 {
2653   boolean eject_button_is_active = TAPE_IS_STOPPED(tape);
2654   boolean extra_button_is_active = !eject_button_is_active;
2655
2656   if (key == setup.shortcut.tape_eject && eject_button_is_active)
2657     HandleTapeButtonsExt(TAPE_CTRL_ID_EJECT);
2658   else if (key == setup.shortcut.tape_extra && extra_button_is_active)
2659     HandleTapeButtonsExt(TAPE_CTRL_ID_EXTRA);
2660   else if (key == setup.shortcut.tape_stop)
2661     HandleTapeButtonsExt(TAPE_CTRL_ID_STOP);
2662   else if (key == setup.shortcut.tape_pause)
2663     HandleTapeButtonsExt(TAPE_CTRL_ID_PAUSE);
2664   else if (key == setup.shortcut.tape_record)
2665     HandleTapeButtonsExt(TAPE_CTRL_ID_RECORD);
2666   else if (key == setup.shortcut.tape_play)
2667     HandleTapeButtonsExt(TAPE_CTRL_ID_PLAY);
2668 }