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