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