38bc0166394f487ef64a31a979ad25e4e89b316c
[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   // set unique basename for score tape (for uploading to score server)
1385   strcpy(tape.score_tape_basename, getScoreTapeBasename(setup.player_name));
1386
1387   // store score in first score entry
1388   scores.last_added = 0;
1389
1390   struct ScoreEntry *entry = &scores.entry[scores.last_added];
1391
1392   strncpy(entry->tape_basename, tape.score_tape_basename, MAX_FILENAME_LEN);
1393   strncpy(entry->name, setup.player_name, MAX_PLAYER_NAME_LEN);
1394
1395   entry->score = score;
1396   entry->time = time;
1397
1398   PrintNoLog("- uploading score tape to score server ... ");
1399
1400   server_scores.uploaded = FALSE;
1401 }
1402
1403 static boolean AutoPlayTapes_WaitForUpload(void)
1404 {
1405   unsigned int upload_delay = 0;
1406   unsigned int upload_delay_value = 10000;
1407
1408   ResetDelayCounter(&upload_delay);
1409
1410   // wait for score tape to be successfully uploaded (and fail on timeout)
1411   while (!server_scores.uploaded)
1412   {
1413     if (DelayReached(&upload_delay, upload_delay_value))
1414     {
1415       PrintNoLog("\r");
1416       Print("- uploading score tape to score server - TIMEOUT.\n");
1417
1418       if (program.headless)
1419         Fail("cannot upload score tape to score server");
1420
1421       return FALSE;
1422     }
1423
1424     UPDATE_BUSY_STATE();
1425
1426     Delay(20);
1427   }
1428
1429   PrintNoLog("\r");
1430   Print("- uploading score tape to score server - uploaded.\n");
1431
1432   return TRUE;
1433 }
1434
1435 static int AutoPlayTapesExt(boolean initialize)
1436 {
1437   static struct AutoPlayInfo autoplay;
1438   static int num_tapes = 0;
1439   static int patch_nr = 0;
1440   static char *patch_name[] =
1441   {
1442     "original tape",
1443     "em_random_bug",
1444     "screen_34x34",
1445
1446     NULL
1447   };
1448   static int patch_version_first[] =
1449   {
1450     VERSION_IDENT(0,0,0,0),
1451     VERSION_IDENT(3,3,1,0),
1452     VERSION_IDENT(0,0,0,0),
1453
1454     -1
1455   };
1456   static int patch_version_last[] =
1457   {
1458     VERSION_IDENT(9,9,9,9),
1459     VERSION_IDENT(4,0,1,1),
1460     VERSION_IDENT(4,2,2,0),
1461
1462     -1
1463   };
1464   static byte patch_property_bit[] =
1465   {
1466     TAPE_PROPERTY_NONE,
1467     TAPE_PROPERTY_EM_RANDOM_BUG,
1468     TAPE_PROPERTY_NONE,
1469
1470     -1
1471   };
1472   LevelDirTree *leveldir_current_last = leveldir_current;
1473   boolean init_level_set = FALSE;
1474   int level_nr_last = level_nr;
1475   int i;
1476
1477   if (!initialize)
1478   {
1479     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1480     {
1481       if (tape.auto_play_level_solved)
1482       {
1483         if (patch_nr > 0)
1484         {
1485           // level solved by patched tape -- save fixed tape
1486           char *filename = getTapeFilename(level_nr);
1487           char *filename_orig = getStringCat2(filename, ".orig");
1488
1489           // create backup from old tape, if not yet existing
1490           if (!fileExists(filename_orig))
1491             rename(filename, filename_orig);
1492
1493           SaveTapeToFilename(filename);
1494
1495           tape.auto_play_level_fixed = TRUE;
1496           autoplay.num_tapes_patched++;
1497         }
1498
1499         // continue with next tape
1500         patch_nr = 0;
1501       }
1502       else if (patch_name[patch_nr + 1] != NULL)
1503       {
1504         // level not solved by patched tape -- continue with next patch
1505         patch_nr++;
1506       }
1507       else
1508       {
1509         // level not solved by any patched tape -- continue with next tape
1510         tape.auto_play_level_not_fixable = TRUE;
1511         patch_nr = 0;
1512       }
1513     }
1514
1515     // just finished auto-playing tape
1516     PrintTapeReplayProgress(TRUE);
1517
1518     if (options.tape_log_filename != NULL)
1519       CloseTapeLogfile();
1520
1521     if (global.autoplay_mode == AUTOPLAY_MODE_SAVE &&
1522         tape.auto_play_level_solved)
1523     {
1524       AutoPlayTapes_SetScoreEntry(game.score_final, game.score_time_final);
1525
1526       if (leveldir_current)
1527       {
1528         // the tape's level set identifier may differ from current level set
1529         strncpy(tape.level_identifier, leveldir_current->identifier,
1530                 MAX_FILENAME_LEN);
1531         tape.level_identifier[MAX_FILENAME_LEN] = '\0';
1532
1533         // the tape's level number may differ from current level number
1534         tape.level_nr = level_nr;
1535       }
1536
1537       // save score tape to upload to server; may be required for some reasons:
1538       // * level set identifier in solution tapes may differ from level set
1539       // * level set identifier is missing (old-style tape without INFO chunk)
1540       // * solution tape may have native format (like Supaplex solution files)
1541
1542       SaveScoreTape(level_nr);
1543       SaveServerScore(level_nr);
1544
1545       AutoPlayTapes_WaitForUpload();
1546     }
1547
1548     if (patch_nr == 0)
1549       autoplay.num_levels_played++;
1550
1551     if (tape.auto_play_level_solved)
1552       autoplay.num_levels_solved++;
1553
1554     if (level_nr >= 0 && level_nr < MAX_TAPES_PER_SET)
1555       autoplay.level_failed[level_nr] = !tape.auto_play_level_solved;
1556   }
1557   else
1558   {
1559     if (strEqual(global.autoplay_leveldir, "ALL"))
1560     {
1561       autoplay.all_levelsets = TRUE;
1562
1563       // tape mass-uploading only allowed for private tapes
1564       if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
1565         options.mytapes = TRUE;
1566     }
1567
1568     if ((global.autoplay_mode == AUTOPLAY_MODE_SAVE ||
1569          global.autoplay_mode == AUTOPLAY_MODE_UPLOAD) &&
1570         !options.mytapes &&
1571         options.player_name == NULL)
1572     {
1573       Fail("specify player name when uploading solution tapes");
1574     }
1575
1576     if (global.autoplay_mode != AUTOPLAY_MODE_UPLOAD)
1577       DrawCompleteVideoDisplay();
1578
1579     if (program.headless)
1580     {
1581       audio.sound_enabled = FALSE;
1582       setup.engine_snapshot_mode = getStringCopy(STR_SNAPSHOT_MODE_OFF);
1583     }
1584
1585     if (strSuffix(global.autoplay_leveldir, ".tape"))
1586     {
1587       autoplay.tape_filename = global.autoplay_leveldir;
1588
1589       if (!fileExists(autoplay.tape_filename))
1590         Fail("tape file '%s' does not exist", autoplay.tape_filename);
1591
1592       LoadTapeFromFilename(autoplay.tape_filename);
1593
1594       if (tape.no_valid_file)
1595         Fail("cannot load tape file '%s'", autoplay.tape_filename);
1596
1597       if (tape.no_info_chunk && !options.identifier)
1598         Fail("cannot get levelset from tape file '%s'", autoplay.tape_filename);
1599
1600       if (tape.no_info_chunk && !options.level_nr)
1601         Fail("cannot get level nr from tape file '%s'", autoplay.tape_filename);
1602
1603       global.autoplay_leveldir = tape.level_identifier;
1604
1605       if (options.identifier != NULL)
1606         global.autoplay_leveldir = options.identifier;
1607
1608       if (options.level_nr != NULL)
1609         tape.level_nr = atoi(options.level_nr);
1610
1611       if (tape.level_nr >= 0 && tape.level_nr < MAX_TAPES_PER_SET)
1612         global.autoplay_level[tape.level_nr] = TRUE;
1613
1614       global.autoplay_all = FALSE;
1615     }
1616
1617     if (autoplay.all_levelsets)
1618     {
1619       // start auto-playing first level set
1620       autoplay.leveldir = getFirstValidAutoPlayEntry(leveldir_first);
1621     }
1622     else
1623     {
1624       // auto-play selected level set
1625       autoplay.leveldir = getTreeInfoFromIdentifier(leveldir_first,
1626                                                     global.autoplay_leveldir);
1627     }
1628
1629     if (autoplay.leveldir == NULL)
1630       Fail("no such level identifier: '%s'", global.autoplay_leveldir);
1631
1632     // only private tapes may be modified
1633     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1634       options.mytapes = TRUE;
1635
1636     // set timestamp for batch tape upload
1637     global.autoplay_time = time(NULL);
1638
1639     num_tapes = 0;
1640
1641     init_level_set = TRUE;
1642   }
1643
1644   while (1)
1645   {
1646     if (init_level_set)
1647     {
1648       leveldir_current = autoplay.leveldir;
1649
1650       if (autoplay.leveldir->first_level < 0)
1651         autoplay.leveldir->first_level = 0;
1652       if (autoplay.leveldir->last_level >= MAX_TAPES_PER_SET)
1653         autoplay.leveldir->last_level = MAX_TAPES_PER_SET - 1;
1654
1655       autoplay.level_nr = autoplay.leveldir->first_level;
1656
1657       autoplay.num_levels_played = 0;
1658       autoplay.num_levels_solved = 0;
1659       autoplay.num_tapes_patched = 0;
1660       autoplay.num_tape_missing = 0;
1661
1662       for (i = 0; i < MAX_TAPES_PER_SET; i++)
1663         autoplay.level_failed[i] = FALSE;
1664
1665       PrintTapeReplayHeader(&autoplay);
1666
1667       init_level_set = FALSE;
1668     }
1669
1670     if (global.autoplay_mode != AUTOPLAY_MODE_FIX || patch_nr == 0)
1671       level_nr = autoplay.level_nr++;
1672
1673     UPDATE_BUSY_STATE();
1674
1675     // check if all tapes for this level set have been processed
1676     if (level_nr > autoplay.leveldir->last_level)
1677     {
1678       PrintTapeReplaySummary(&autoplay);
1679
1680       if (!autoplay.all_levelsets)
1681         break;
1682
1683       // continue with next level set
1684       autoplay.leveldir = getNextValidAutoPlayEntry(autoplay.leveldir);
1685
1686       // all level sets processed
1687       if (autoplay.leveldir == NULL)
1688         break;
1689
1690       init_level_set = TRUE;
1691
1692       continue;
1693     }
1694
1695     // set patch info (required for progress output)
1696     strcpy(tape_patch_info, "");
1697     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1698       snprintf(tape_patch_info, MAX_OUTPUT_LINESIZE, "[%-13s] ",
1699                patch_name[patch_nr]);
1700
1701     if (!global.autoplay_all && !global.autoplay_level[level_nr])
1702       continue;
1703
1704     char *tape_filename = (autoplay.tape_filename ? autoplay.tape_filename :
1705                            options.mytapes ? getTapeFilename(level_nr) :
1706                            getSolutionTapeFilename(level_nr));
1707
1708     // speed things up in case of missing tapes (by skipping loading level)
1709     if (!fileExists(tape_filename))
1710     {
1711       autoplay.num_tape_missing++;
1712
1713       Print("Tape %03d: (no tape found)\n", level_nr);
1714
1715       continue;
1716     }
1717
1718     TapeErase();
1719     TapeRewind();       // needed to reset "tape.auto_play_level_solved"
1720
1721     LoadLevel(level_nr);
1722
1723     if (level.no_level_file || level.no_valid_file)
1724     {
1725       Print("Tape %03d: (no level found)\n", level_nr);
1726
1727       continue;
1728     }
1729
1730 #if 0
1731     // ACTIVATE THIS FOR LOADING/TESTING OF LEVELS ONLY
1732     Print("Tape %03d: (only testing level)\n", level_nr);
1733     continue;
1734 #endif
1735
1736     if (autoplay.tape_filename)
1737       LoadTapeFromFilename(autoplay.tape_filename);
1738     else if (options.mytapes)
1739       LoadTape(level_nr);
1740     else
1741       LoadSolutionTape(level_nr);
1742
1743     if (tape.no_valid_file)
1744     {
1745       autoplay.num_tape_missing++;
1746
1747       Print("Tape %03d: (invalid tape)\n", level_nr);
1748
1749       continue;
1750     }
1751
1752     if (global.autoplay_mode == AUTOPLAY_MODE_FIX)
1753     {
1754       boolean skip_patch = FALSE;
1755
1756       if (tape.engine_version < patch_version_first[patch_nr] ||
1757           tape.engine_version > patch_version_last[patch_nr])
1758       {
1759         Print("Tape %03d %s[%02d:%02d]: (%s %d.%d.%d.%d) - skipped.\n",
1760               level_nr,  tape_patch_info,
1761               tape.length_seconds / 60, tape.length_seconds % 60,
1762               "not suitable for version",
1763               (tape.engine_version / 1000000) % 100,
1764               (tape.engine_version / 10000  ) % 100,
1765               (tape.engine_version / 100    ) % 100,
1766               (tape.engine_version          ) % 100);
1767
1768         skip_patch = TRUE;
1769       }
1770
1771       if (strEqual(patch_name[patch_nr], "screen_34x34") &&
1772           tape.num_participating_players == 1)
1773       {
1774         Print("Tape %03d %s[%02d:%02d]: (%s) - skipped.\n",
1775               level_nr,  tape_patch_info,
1776               tape.length_seconds / 60, tape.length_seconds % 60,
1777               "not suitable for single player tapes");
1778
1779         skip_patch = TRUE;
1780       }
1781
1782       if (skip_patch)
1783       {
1784         if (patch_name[patch_nr + 1] != NULL)
1785         {
1786           // continue with next patch
1787           patch_nr++;
1788         }
1789         else
1790         {
1791           // continue with next tape
1792           patch_nr = 0;
1793         }
1794
1795         continue;
1796       }
1797
1798       if (strEqual(patch_name[patch_nr], "screen_34x34"))
1799       {
1800         tape.scr_fieldx = SCR_FIELDX_DEFAULT * 2;
1801         tape.scr_fieldy = SCR_FIELDY_DEFAULT * 2;
1802       }
1803       else
1804       {
1805         tape.property_bits |= patch_property_bit[patch_nr];
1806       }
1807     }
1808
1809     num_tapes++;
1810
1811     if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
1812     {
1813       boolean use_temporary_tape_file = FALSE;
1814
1815       Print("Tape %03d:\n", level_nr);
1816
1817       AutoPlayTapes_SetScoreEntry(0, 0);
1818
1819       if (autoplay.tape_filename == NULL)
1820       {
1821         autoplay.tape_filename = (options.mytapes ? getTapeFilename(level_nr) :
1822                                   getDefaultSolutionTapeFilename(level_nr));
1823
1824         if (!fileExists(autoplay.tape_filename))
1825         {
1826           // non-standard or incorrect solution tape -- save to temporary file
1827           autoplay.tape_filename = getTemporaryTapeFilename();
1828
1829           SaveTapeToFilename(autoplay.tape_filename);
1830
1831           use_temporary_tape_file = TRUE;
1832         }
1833       }
1834
1835       SaveServerScoreFromFile(level_nr, autoplay.tape_filename);
1836
1837       boolean success = AutoPlayTapes_WaitForUpload();
1838
1839       if (use_temporary_tape_file)
1840         unlink(autoplay.tape_filename);
1841
1842       // required for uploading multiple tapes
1843       autoplay.tape_filename = NULL;
1844
1845       if (!success)
1846       {
1847         num_tapes = -1;
1848
1849         break;
1850       }
1851
1852       continue;
1853     }
1854
1855     InitCounter();
1856
1857     if (options.tape_log_filename != NULL)
1858       OpenTapeLogfile();
1859
1860     TapeStartGamePlaying();
1861     TapeStartWarpForward(global.autoplay_mode);
1862
1863     autoplay.last_level_nr = level_nr;
1864
1865     return num_tapes;
1866   }
1867
1868   if (global.autoplay_mode == AUTOPLAY_MODE_UPLOAD)
1869   {
1870     Print("\n");
1871     PrintLine("=", 79);
1872
1873     if (num_tapes >= 0)
1874       Print("SUMMARY: %d tapes uploaded.\n", num_tapes);
1875     else
1876       Print("SUMMARY: Uploading tapes failed.\n");
1877
1878     PrintLine("=", 79);
1879   }
1880
1881   // clear timestamp for batch tape upload (required after interactive upload)
1882   global.autoplay_time = 0;
1883
1884   // exit if running headless or if visually auto-playing tapes
1885   if (program.headless || global.autoplay_mode != AUTOPLAY_MODE_UPLOAD)
1886     CloseAllAndExit(0);
1887
1888   // when running interactively, restore last selected level set and number
1889   leveldir_current = leveldir_current_last;
1890   level_nr = level_nr_last;
1891
1892   return num_tapes;
1893 }
1894
1895 int AutoPlayTapes(void)
1896 {
1897   return AutoPlayTapesExt(TRUE);
1898 }
1899
1900 int AutoPlayTapesContinue(void)
1901 {
1902   return AutoPlayTapesExt(FALSE);
1903 }
1904
1905
1906 // ----------------------------------------------------------------------------
1907 // tape patch functions
1908 // ----------------------------------------------------------------------------
1909
1910 static boolean PatchTape(struct TapeInfo *tape, char *mode)
1911 {
1912   Print("[%d.%d.%d.%d]: ",
1913         (tape->engine_version / 1000000) % 100,
1914         (tape->engine_version / 10000  ) % 100,
1915         (tape->engine_version / 100    ) % 100,
1916         (tape->engine_version          ) % 100);
1917
1918   if (strEqual(mode, "info"))
1919   {
1920     Print("property bits == 0x%02x\n", tape->property_bits);
1921
1922     return FALSE;
1923   }
1924
1925   boolean unpatch_tape = FALSE;
1926   boolean use_property_bit = FALSE;
1927   byte property_bitmask = 0;
1928
1929   if (strSuffix(mode, ":0") ||
1930       strSuffix(mode, ":off") ||
1931       strSuffix(mode, ":clear"))
1932     unpatch_tape = TRUE;
1933
1934   if (strEqual(mode, "em_random_bug") || strPrefix(mode, "em_random_bug:"))
1935   {
1936     // this bug was introduced in version 3.3.1.0 and fixed in version 4.0.1.2
1937     if (tape->engine_version <  VERSION_IDENT(3,3,1,0) ||
1938         tape->engine_version >= VERSION_IDENT(4,0,1,2))
1939     {
1940       Print("This tape version cannot be patched against EM random bug!\n");
1941
1942       return FALSE;
1943     }
1944
1945     property_bitmask = TAPE_PROPERTY_EM_RANDOM_BUG;
1946
1947     use_property_bit = TRUE;
1948   }
1949   else if (strEqual(mode, "screen_34x34") || strPrefix(mode, "screen_34x34:"))
1950   {
1951     // this bug only affects team mode tapes
1952     if (tape->num_participating_players == 1)
1953     {
1954       Print("Only team mode tapes can be patched against screen size bug!\n");
1955
1956       return FALSE;
1957     }
1958
1959     // this bug (that always existed before) was fixed in version 4.2.2.1
1960     if (tape->engine_version >= VERSION_IDENT(4,2,2,1))
1961     {
1962       Print("This tape version cannot be patched against screen size bug!\n");
1963
1964       return FALSE;
1965     }
1966
1967     int factor = (unpatch_tape ? 1 : 2);
1968     int scr_fieldx_new = SCR_FIELDX_DEFAULT * factor;
1969     int scr_fieldy_new = SCR_FIELDY_DEFAULT * factor;
1970
1971     if (scr_fieldx_new == tape->scr_fieldx &&
1972         scr_fieldy_new == tape->scr_fieldy)
1973     {
1974       Print("Tape already patched for '%s'!\n", mode);
1975
1976       return FALSE;
1977     }
1978
1979     tape->scr_fieldx = scr_fieldx_new;
1980     tape->scr_fieldy = scr_fieldy_new;
1981   }
1982   else
1983   {
1984     Print("Unknown patch mode '%s'!\n", mode);
1985
1986     return FALSE;
1987   }
1988
1989   // patching tapes using property bits may be used for several patch modes
1990   if (use_property_bit)
1991   {
1992     byte property_bits = tape->property_bits;
1993     boolean set_property_bit = (unpatch_tape ? FALSE : TRUE);
1994
1995     if (set_property_bit)
1996       property_bits |= property_bitmask;
1997     else
1998       property_bits &= ~property_bitmask;
1999
2000     if (property_bits == tape->property_bits)
2001     {
2002       Print("Tape already patched for '%s'!\n", mode);
2003
2004       return FALSE;
2005     }
2006
2007     tape->property_bits = property_bits;
2008   }
2009
2010   Print("Patching for '%s' ... ", mode);
2011
2012   return TRUE;
2013 }
2014
2015 void PatchTapes(void)
2016 {
2017   static LevelDirTree *patchtapes_leveldir = NULL;
2018   static int num_tapes_found = 0;
2019   static int num_tapes_patched = 0;
2020   char *mode = global.patchtapes_mode;
2021   int i;
2022
2023   if (strEqual(mode, "help"))
2024   {
2025     PrintLine("=", 79);
2026     Print("Supported patch modes:\n");
2027     Print("- \"em_random_bug\"   - use 64-bit random value bug for EM engine\n");
2028     Print("- \"screen_34x34\"    - force visible playfield size of 34 x 34\n");
2029     PrintLine("-", 79);
2030     Print("Supported modifiers:\n");
2031     Print("- add \":0\", \":off\" or \":clear\" to patch mode to un-patch tape file\n");
2032     PrintLine("=", 79);
2033
2034     CloseAllAndExit(0);
2035   }
2036
2037   patchtapes_leveldir = getTreeInfoFromIdentifier(leveldir_first,
2038                                                   global.patchtapes_leveldir);
2039
2040   if (patchtapes_leveldir == NULL)
2041     Fail("no such level identifier: '%s'", global.patchtapes_leveldir);
2042
2043   leveldir_current = patchtapes_leveldir;
2044
2045   if (patchtapes_leveldir->first_level < 0)
2046     patchtapes_leveldir->first_level = 0;
2047   if (patchtapes_leveldir->last_level >= MAX_TAPES_PER_SET)
2048     patchtapes_leveldir->last_level = MAX_TAPES_PER_SET - 1;
2049
2050   PrintLine("=", 79);
2051   Print("Patching level tapes for patch mode '%s'\n", mode);
2052   PrintLine("-", 79);
2053   Print("Level series identifier: '%s'\n", patchtapes_leveldir->identifier);
2054   Print("Level series name:       '%s'\n", patchtapes_leveldir->name);
2055   Print("Level series author:     '%s'\n", patchtapes_leveldir->author);
2056   Print("Number of levels:        %d\n",   patchtapes_leveldir->levels);
2057   PrintLine("=", 79);
2058   Print("\n");
2059
2060   int first_level = patchtapes_leveldir->first_level;
2061   int last_level = patchtapes_leveldir->last_level;
2062
2063   for (i = first_level; i <= last_level; i++)
2064   {
2065     if (!global.patchtapes_all && !global.patchtapes_level[i])
2066       continue;
2067
2068     Print("Tape %03d: ", i);
2069
2070     TapeErase();
2071     LoadTape(i);
2072
2073     if (tape.no_valid_file)
2074     {
2075       Print("(no tape found)\n");
2076
2077       continue;
2078     }
2079
2080     num_tapes_found++;
2081
2082     if (PatchTape(&tape, mode))
2083     {
2084       char *filename = getTapeFilename(i);
2085       char *filename_orig = getStringCat2(filename, ".orig");
2086
2087       if (!fileExists(filename_orig))
2088         rename(filename, filename_orig);
2089
2090       SaveTapeToFilename(filename);
2091
2092       Print("patched tape saved.\n");
2093
2094       num_tapes_patched++;
2095     }
2096   }
2097
2098   Print("\n");
2099   PrintLine("=", 79);
2100   Print("Number of tapes found: %d\n", num_tapes_found);
2101   Print("Number of tapes patched: %d\n", num_tapes_patched);
2102   PrintLine("=", 79);
2103
2104   CloseAllAndExit(0);
2105 }
2106
2107
2108 // ---------- new tape button stuff -------------------------------------------
2109
2110 static struct
2111 {
2112   int graphic;
2113   struct XY *pos;
2114   int gadget_id;
2115   char *infotext;
2116 } tapebutton_info[NUM_TAPE_BUTTONS] =
2117 {
2118   {
2119     IMG_GFX_TAPE_BUTTON_EJECT,          &tape.button.eject,
2120     TAPE_CTRL_ID_EJECT,                 "eject tape"
2121   },
2122   {
2123     // (same position as "eject" button)
2124     IMG_GFX_TAPE_BUTTON_EXTRA,          &tape.button.eject,
2125     TAPE_CTRL_ID_EXTRA,                 "extra functions"
2126   },
2127   {
2128     IMG_GFX_TAPE_BUTTON_STOP,           &tape.button.stop,
2129     TAPE_CTRL_ID_STOP,                  "stop tape"
2130   },
2131   {
2132     IMG_GFX_TAPE_BUTTON_PAUSE,          &tape.button.pause,
2133     TAPE_CTRL_ID_PAUSE,                 "pause tape"
2134   },
2135   {
2136     IMG_GFX_TAPE_BUTTON_RECORD,         &tape.button.record,
2137     TAPE_CTRL_ID_RECORD,                "record tape"
2138   },
2139   {
2140     IMG_GFX_TAPE_BUTTON_PLAY,           &tape.button.play,
2141     TAPE_CTRL_ID_PLAY,                  "play tape"
2142   },
2143   {
2144     IMG_GFX_TAPE_BUTTON_INSERT_SOLUTION,&tape.button.insert_solution,
2145     TAPE_CTRL_ID_INSERT_SOLUTION,       "insert solution tape"
2146   },
2147   {
2148     IMG_GFX_TAPE_BUTTON_PLAY_SOLUTION,  &tape.button.play_solution,
2149     TAPE_CTRL_ID_PLAY_SOLUTION,         "play solution tape"
2150   }
2151 };
2152
2153 void CreateTapeButtons(void)
2154 {
2155   int i;
2156
2157   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2158   {
2159     int graphic = tapebutton_info[i].graphic;
2160     struct GraphicInfo *gfx = &graphic_info[graphic];
2161     struct XY *pos = tapebutton_info[i].pos;
2162     struct GadgetInfo *gi;
2163     int gd_x = gfx->src_x;
2164     int gd_y = gfx->src_y;
2165     int gd_xp = gfx->src_x + gfx->pressed_xoffset;
2166     int gd_yp = gfx->src_y + gfx->pressed_yoffset;
2167     int id = i;
2168
2169     gi = CreateGadget(GDI_CUSTOM_ID, id,
2170                       GDI_IMAGE_ID, graphic,
2171                       GDI_INFO_TEXT, tapebutton_info[i].infotext,
2172                       GDI_X, VX + pos->x,
2173                       GDI_Y, VY + pos->y,
2174                       GDI_WIDTH, gfx->width,
2175                       GDI_HEIGHT, gfx->height,
2176                       GDI_TYPE, GD_TYPE_NORMAL_BUTTON,
2177                       GDI_STATE, GD_BUTTON_UNPRESSED,
2178                       GDI_DESIGN_UNPRESSED, gfx->bitmap, gd_x, gd_y,
2179                       GDI_DESIGN_PRESSED, gfx->bitmap, gd_xp, gd_yp,
2180                       GDI_DIRECT_DRAW, FALSE,
2181                       GDI_EVENT_MASK, GD_EVENT_RELEASED,
2182                       GDI_CALLBACK_ACTION, HandleTapeButtons,
2183                       GDI_END);
2184
2185     if (gi == NULL)
2186       Fail("cannot create gadget");
2187
2188     tape_gadget[id] = gi;
2189   }
2190 }
2191
2192 void FreeTapeButtons(void)
2193 {
2194   int i;
2195
2196   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2197     FreeGadget(tape_gadget[i]);
2198 }
2199
2200 void MapTapeEjectButton(void)
2201 {
2202   UnmapGadget(tape_gadget[TAPE_CTRL_ID_EXTRA]);
2203   MapGadget(tape_gadget[TAPE_CTRL_ID_EJECT]);
2204 }
2205
2206 void MapTapeWarpButton(void)
2207 {
2208   UnmapGadget(tape_gadget[TAPE_CTRL_ID_EJECT]);
2209   MapGadget(tape_gadget[TAPE_CTRL_ID_EXTRA]);
2210 }
2211
2212 void MapTapeButtons(void)
2213 {
2214   int i;
2215
2216   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2217     if (i != TAPE_CTRL_ID_EXTRA)
2218       MapGadget(tape_gadget[i]);
2219
2220   if (tape.recording || tape.playing)
2221     MapTapeWarpButton();
2222
2223   if (tape.show_game_buttons)
2224     MapGameButtonsOnTape();
2225 }
2226
2227 void UnmapTapeButtons(void)
2228 {
2229   int i;
2230
2231   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2232     UnmapGadget(tape_gadget[i]);
2233
2234   if (tape.show_game_buttons)
2235     UnmapGameButtonsOnTape();
2236 }
2237
2238 void RedrawTapeButtons(void)
2239 {
2240   int i;
2241
2242   for (i = 0; i < NUM_TAPE_BUTTONS; i++)
2243     RedrawGadget(tape_gadget[i]);
2244
2245   if (tape.show_game_buttons)
2246     RedrawGameButtonsOnTape();
2247 }
2248
2249 void RedrawOrRemapTapeButtons(void)
2250 {
2251   if (tape_gadget[TAPE_CTRL_ID_PLAY]->mapped)
2252   {
2253     // tape buttons already mapped
2254     RedrawTapeButtons();
2255   }
2256   else
2257   {
2258     UnmapTapeButtons();
2259     MapTapeButtons();
2260   }
2261 }
2262
2263 static void HandleTapeButtonsExt(int id)
2264 {
2265   if (game_status != GAME_MODE_MAIN && game_status != GAME_MODE_PLAYING)
2266     return;
2267
2268   switch (id)
2269   {
2270     case TAPE_CTRL_ID_EJECT:
2271       TapeStop();
2272
2273       if (TAPE_IS_EMPTY(tape))
2274       {
2275         LoadTape(level_nr);
2276
2277         if (TAPE_IS_EMPTY(tape))
2278           Request("No tape for this level!", REQ_CONFIRM);
2279       }
2280       else
2281       {
2282         if (tape.changed)
2283           SaveTapeChecked(level_nr);
2284
2285         TapeErase();
2286       }
2287
2288       DrawCompleteVideoDisplay();
2289       break;
2290
2291     case TAPE_CTRL_ID_EXTRA:
2292       if (tape.playing)
2293       {
2294         tape.pause_before_end = !tape.pause_before_end;
2295
2296         DrawVideoDisplayCurrentState();
2297       }
2298       else if (tape.recording)
2299       {
2300         TapeSingleStep();
2301       }
2302
2303       break;
2304
2305     case TAPE_CTRL_ID_STOP:
2306       TapeStop();
2307
2308       break;
2309
2310     case TAPE_CTRL_ID_PAUSE:
2311       TapeTogglePause(TAPE_TOGGLE_MANUAL);
2312
2313       break;
2314
2315     case TAPE_CTRL_ID_RECORD:
2316       if (TAPE_IS_STOPPED(tape))
2317       {
2318         TapeStartGameRecording();
2319       }
2320       else if (tape.pausing)
2321       {
2322         if (tape.playing)                       // PLAY -> PAUSE -> RECORD
2323           TapeAppendRecording();
2324         else
2325           TapeTogglePause(TAPE_TOGGLE_MANUAL);
2326       }
2327
2328       break;
2329
2330     case TAPE_CTRL_ID_PLAY:
2331       if (tape.recording && tape.pausing)       // PAUSE -> RECORD
2332       {
2333         // ("TAPE_IS_EMPTY(tape)" is TRUE here -- probably fix this)
2334
2335         TapeTogglePause(TAPE_TOGGLE_MANUAL);
2336       }
2337
2338       if (TAPE_IS_EMPTY(tape))
2339         break;
2340
2341       if (TAPE_IS_STOPPED(tape))
2342       {
2343         TapeStartGamePlaying();
2344       }
2345       else if (tape.playing)
2346       {
2347         if (tape.pausing)                       // PAUSE -> PLAY
2348         {
2349           TapeTogglePause(TAPE_TOGGLE_MANUAL | TAPE_TOGGLE_PLAY_PAUSE);
2350         }
2351         else if (!tape.fast_forward)            // PLAY -> FFWD
2352         {
2353           tape.fast_forward = TRUE;
2354         }
2355         else if (!tape.warp_forward)            // FFWD -> WARP
2356         {
2357           tape.warp_forward = TRUE;
2358         }
2359         else if (!tape.deactivate_display)      // WARP -> WARP BLIND
2360         {
2361           tape.deactivate_display = TRUE;
2362
2363           TapeDeactivateDisplayOn();
2364         }
2365         else                                    // WARP BLIND -> PLAY
2366         {
2367           tape.fast_forward = FALSE;
2368           tape.warp_forward = FALSE;
2369           tape.deactivate_display = FALSE;
2370
2371           TapeDeactivateDisplayOff(game_status == GAME_MODE_PLAYING);
2372         }
2373
2374         DrawVideoDisplayCurrentState();
2375       }
2376
2377       break;
2378
2379     case TAPE_CTRL_ID_INSERT_SOLUTION:
2380       InsertSolutionTape();
2381
2382       break;
2383
2384     case TAPE_CTRL_ID_PLAY_SOLUTION:
2385       PlaySolutionTape();
2386
2387       break;
2388
2389     default:
2390       break;
2391   }
2392 }
2393
2394 static void HandleTapeButtons(struct GadgetInfo *gi)
2395 {
2396   HandleTapeButtonsExt(gi->custom_id);
2397 }
2398
2399 void HandleTapeButtonKeys(Key key)
2400 {
2401   boolean eject_button_is_active = TAPE_IS_STOPPED(tape);
2402   boolean extra_button_is_active = !eject_button_is_active;
2403
2404   if (key == setup.shortcut.tape_eject && eject_button_is_active)
2405     HandleTapeButtonsExt(TAPE_CTRL_ID_EJECT);
2406   else if (key == setup.shortcut.tape_extra && extra_button_is_active)
2407     HandleTapeButtonsExt(TAPE_CTRL_ID_EXTRA);
2408   else if (key == setup.shortcut.tape_stop)
2409     HandleTapeButtonsExt(TAPE_CTRL_ID_STOP);
2410   else if (key == setup.shortcut.tape_pause)
2411     HandleTapeButtonsExt(TAPE_CTRL_ID_PAUSE);
2412   else if (key == setup.shortcut.tape_record)
2413     HandleTapeButtonsExt(TAPE_CTRL_ID_RECORD);
2414   else if (key == setup.shortcut.tape_play)
2415     HandleTapeButtonsExt(TAPE_CTRL_ID_PLAY);
2416 }