fixed bug with not fading menu music on title screen when changing level set
[rocksndiamonds.git] / src / tape.h
index 1727ecf50faa4e6c46e1418bcebc5c4408ef3e48..40ddd0949e39dbd36f8ef830c834802b998983e1 100644 (file)
@@ -1,24 +1,33 @@
-/***********************************************************
-*  Rocks'n'Diamonds -- McDuffin Strikes Back!              *
-*----------------------------------------------------------*
-*  (c) 1995-98 Artsoft Entertainment                       *
-*              Holger Schemel                              *
-*              Oststrasse 11a                              *
-*              33604 Bielefeld                             *
-*              phone: ++49 +521 290471                     *
-*              email: aeglos@valinor.owl.de                *
-*----------------------------------------------------------*
-*  tape.c                                                  *
-***********************************************************/
+// ============================================================================
+// Rocks'n'Diamonds - McDuffin Strikes Back!
+// ----------------------------------------------------------------------------
+// (c) 1995-2014 by Artsoft Entertainment
+//                         Holger Schemel
+//                 info@artsoft.org
+//                 http://www.artsoft.org/
+// ----------------------------------------------------------------------------
+// tape.h
+// ============================================================================
 
 #ifndef TAPE_H
 #define TAPE_H
 
-#include "main.h"
 
-#define TAPE_PAUSE_SECONDS_BEFORE_DEATH                3
+// values for TapeTogglePause()
+#define        TAPE_TOGGLE_AUTOMATIC   0
+#define        TAPE_TOGGLE_MANUAL      (1 << 0)
+#define        TAPE_TOGGLE_PLAY_PAUSE  (1 << 1)
 
-/* some positions in the video tape control window */
+// values for tape properties
+#define MAX_TAPE_LEN           (1000 * FRAMES_PER_SECOND) // max.time x fps
+
+// values for tape mouse actions
+#define TAPE_ACTION_LX         0
+#define TAPE_ACTION_LY         1
+#define TAPE_ACTION_BUTTON     2
+#define TAPE_ACTION_UNUSED     3
+
+// some positions in the video tape control window
 #define VIDEO_DISPLAY1_XPOS    5
 #define VIDEO_DISPLAY1_YPOS    5
 #define VIDEO_DISPLAY2_XPOS    5
 #define VIDEO_CONTROL_XSIZE    VIDEO_DISPLAY_XSIZE
 #define VIDEO_CONTROL_YSIZE    VIDEO_BUTTON_YSIZE
 
-/* values for video tape control */
-#define VIDEO_STATE_PLAY_OFF   (1L << 0)
-#define VIDEO_STATE_PLAY_ON    (1L << 1)
-#define VIDEO_STATE_PLAY       (VIDEO_STATE_PLAY_OFF   | VIDEO_STATE_PLAY_ON)
-#define VIDEO_STATE_REC_OFF    (1L << 2)
-#define VIDEO_STATE_REC_ON     (1L << 3)
-#define VIDEO_STATE_REC                (VIDEO_STATE_REC_OFF    | VIDEO_STATE_REC_ON)
-#define VIDEO_STATE_PAUSE_OFF  (1L << 4)
-#define VIDEO_STATE_PAUSE_ON   (1L << 5)
-#define VIDEO_STATE_PAUSE      (VIDEO_STATE_PAUSE_OFF  | VIDEO_STATE_PAUSE_ON)
-#define VIDEO_STATE_DATE_OFF   (1L << 6)
-#define VIDEO_STATE_DATE_ON    (1L << 7)
-#define VIDEO_STATE_DATE       (VIDEO_STATE_DATE_OFF   | VIDEO_STATE_DATE_ON)
-#define VIDEO_STATE_TIME_OFF   (1L << 8)
-#define VIDEO_STATE_TIME_ON    (1L << 9)
-#define VIDEO_STATE_TIME       (VIDEO_STATE_TIME_OFF   | VIDEO_STATE_TIME_ON)
-#define VIDEO_PRESS_PLAY_ON    (1L << 10)
-#define VIDEO_PRESS_PLAY_OFF   (1L << 11)
-#define VIDEO_PRESS_PLAY       (VIDEO_PRESS_PLAY_OFF   | VIDEO_PRESS_PLAY_ON)
-#define VIDEO_PRESS_REC_ON     (1L << 12)
-#define VIDEO_PRESS_REC_OFF    (1L << 13)
-#define VIDEO_PRESS_REC                (VIDEO_PRESS_REC_OFF    | VIDEO_PRESS_REC_ON)
-#define VIDEO_PRESS_PAUSE_ON   (1L << 14)
-#define VIDEO_PRESS_PAUSE_OFF  (1L << 15)
-#define VIDEO_PRESS_PAUSE      (VIDEO_PRESS_PAUSE_OFF  | VIDEO_PRESS_PAUSE_ON)
-#define VIDEO_PRESS_STOP_ON    (1L << 16)
-#define VIDEO_PRESS_STOP_OFF   (1L << 17)
-#define VIDEO_PRESS_STOP       (VIDEO_PRESS_STOP_OFF   | VIDEO_PRESS_STOP_ON)
-#define VIDEO_PRESS_EJECT_ON   (1L << 18)
-#define VIDEO_PRESS_EJECT_OFF  (1L << 19)
-#define VIDEO_PRESS_EJECT      (VIDEO_PRESS_EJECT_OFF  | VIDEO_PRESS_EJECT_ON)
-
-/* special */
-#define VIDEO_STATE_FFWD_OFF   ((1L << 20) | VIDEO_STATE_PAUSE_OFF)
-#define VIDEO_STATE_FFWD_ON    (1L << 21)
-#define VIDEO_STATE_FFWD       (VIDEO_STATE_FFWD_OFF   | VIDEO_STATE_FFWD_ON)
-#define VIDEO_STATE_PBEND_OFF  (1L << 22)
-#define VIDEO_STATE_PBEND_ON   (1L << 23)
-#define VIDEO_STATE_PBEND      (VIDEO_STATE_PBEND_OFF  | VIDEO_STATE_PBEND_ON)
-
-/* tags to draw video display labels or symbols only */
+// values for video tape control
+#define VIDEO_STATE_PLAY_OFF   (1 << 0)
+#define VIDEO_STATE_PLAY_ON    (1 << 1)
+#define VIDEO_STATE_REC_OFF    (1 << 2)
+#define VIDEO_STATE_REC_ON     (1 << 3)
+#define VIDEO_STATE_PAUSE_OFF  (1 << 4)
+#define VIDEO_STATE_PAUSE_ON   (1 << 5)
+#define VIDEO_STATE_DATE_OFF   (1 << 6)
+#define VIDEO_STATE_DATE_ON    (1 << 7)
+#define VIDEO_STATE_TIME_OFF   (1 << 8)
+#define VIDEO_STATE_TIME_ON    (1 << 9)
+#define VIDEO_STATE_FRAME_OFF  (1 << 10)
+#define VIDEO_STATE_FRAME_ON   (1 << 11)
+#define VIDEO_STATE_FFWD_OFF   (1 << 12)
+#define VIDEO_STATE_FFWD_ON    (1 << 13)
+#define VIDEO_STATE_WARP_OFF   (1 << 14)
+#define VIDEO_STATE_WARP_ON    (1 << 15)
+#define VIDEO_STATE_WARP2_OFF  (1 << 16)
+#define VIDEO_STATE_WARP2_ON   (1 << 17)
+#define VIDEO_STATE_PBEND_OFF  (1 << 18)
+#define VIDEO_STATE_PBEND_ON   (1 << 19)
+#define VIDEO_STATE_1STEP_OFF  (1 << 20)
+#define VIDEO_STATE_1STEP_ON   (1 << 21)
+
+#define VIDEO_PRESS_PLAY_ON    (1 << 22)
+#define VIDEO_PRESS_PLAY_OFF   (1 << 23)
+#define VIDEO_PRESS_REC_ON     (1 << 24)
+#define VIDEO_PRESS_REC_OFF    (1 << 25)
+#define VIDEO_PRESS_PAUSE_ON   (1 << 26)
+#define VIDEO_PRESS_PAUSE_OFF  (1 << 27)
+#define VIDEO_PRESS_STOP_ON    (1 << 28)
+#define VIDEO_PRESS_STOP_OFF   (1 << 29)
+#define VIDEO_PRESS_EJECT_ON   (1 << 30)
+#define VIDEO_PRESS_EJECT_OFF  (1 << 31)
+
+#define VIDEO_STATE_PLAY(x)  ((x) ? VIDEO_STATE_PLAY_ON : VIDEO_STATE_PLAY_OFF)
+#define VIDEO_STATE_REC(x)   ((x) ? VIDEO_STATE_REC_ON  : VIDEO_STATE_REC_OFF)
+#define VIDEO_STATE_PAUSE(x) ((x) ? VIDEO_STATE_PAUSE_ON: VIDEO_STATE_PAUSE_OFF)
+#define VIDEO_STATE_DATE(x)  ((x) ? VIDEO_STATE_DATE_ON : VIDEO_STATE_DATE_OFF)
+#define VIDEO_STATE_TIME(x)  ((x) ? VIDEO_STATE_TIME_ON : VIDEO_STATE_TIME_OFF)
+#define VIDEO_STATE_FRAME(x) ((x) ? VIDEO_STATE_FRAME_ON: VIDEO_STATE_FRAME_OFF)
+#define VIDEO_STATE_FFWD(x)  ((x) ? VIDEO_STATE_FFWD_ON : VIDEO_STATE_FFWD_OFF)
+#define VIDEO_STATE_WARP(x)  ((x) ? VIDEO_STATE_WARP_ON : VIDEO_STATE_WARP_OFF)
+#define VIDEO_STATE_WARP2(x) ((x) ? VIDEO_STATE_WARP2_ON: VIDEO_STATE_WARP2_OFF)
+#define VIDEO_STATE_PBEND(x) ((x) ? VIDEO_STATE_PBEND_ON: VIDEO_STATE_PBEND_OFF)
+#define VIDEO_STATE_1STEP(x) ((x) ? VIDEO_STATE_1STEP_ON: VIDEO_STATE_1STEP_OFF)
+
+#define VIDEO_PRESS_PLAY(x)  ((x) ? VIDEO_PRESS_PLAY_ON : VIDEO_PRESS_PLAY_OFF)
+#define VIDEO_PRESS_REC(x)   ((x) ? VIDEO_PRESS_REC_ON  : VIDEO_PRESS_REC_OFF)
+#define VIDEO_PRESS_PAUSE(x) ((x) ? VIDEO_PRESS_PAUSE_ON: VIDEO_PRESS_PAUSE_OFF)
+#define VIDEO_PRESS_STOP(x)  ((x) ? VIDEO_PRESS_STOP_ON : VIDEO_PRESS_STOP_OFF)
+#define VIDEO_PRESS_EJECT(x) ((x) ? VIDEO_PRESS_EJECT_ON: VIDEO_PRESS_EJECT_OFF)
+
+// tags to draw video display labels or symbols only
+// (negative values to prevent misinterpretation in DrawVideoDisplay(), where
+// the variable "value" is also used for tape length -- better fix this)
 #define VIDEO_DISPLAY_DEFAULT          0
-#define VIDEO_DISPLAY_LABEL_ONLY       1
-#define VIDEO_DISPLAY_SYMBOL_ONLY      2
+#define VIDEO_DISPLAY_LABEL_ONLY       -1
+#define VIDEO_DISPLAY_SYMBOL_ONLY      -2
+
+
+struct TapeButtonInfo
+{
+  struct XY eject;
+  struct XY stop;
+  struct XY pause;
+  struct XY record;
+  struct XY play;
+  struct XY insert_solution;
+  struct XY play_solution;
+};
+
+struct TapeSymbolInfo
+{
+  struct XY eject;
+  struct XY stop;
+  struct XY pause;
+  struct XY record;
+  struct XY play;
+  struct XY fast_forward;
+  struct XY warp_forward;
+  struct XY warp_forward_blind;
+  struct XY pause_before_end;
+  struct XY single_step;
+};
+
+struct TapeLabelInfo
+{
+  struct XY eject;
+  struct XY stop;
+  struct XY pause;
+  struct XY record;
+  struct XY play;
+  struct XY fast_forward;
+  struct XY warp_forward;
+  struct XY warp_forward_blind;
+  struct XY pause_before_end;
+  struct XY single_step;
+  struct XY date;
+  struct XY time;
+};
+
+struct TapeTextInfo
+{
+  struct TextPosInfo date;
+  struct TextPosInfo date_yyyy;
+  struct TextPosInfo date_yy;
+  struct TextPosInfo date_mon;
+  struct TextPosInfo date_mm;
+  struct TextPosInfo date_dd;
+
+  struct TextPosInfo time;
+  struct TextPosInfo time_hh;
+  struct TextPosInfo time_mm;
+  struct TextPosInfo time_ss;
+
+  struct TextPosInfo frame;
+};
 
+struct TapeInfo
+{
+  int file_version;    // file format version the tape is stored with
+  int game_version;    // game release version the tape was created with
+  int engine_version;  // game engine version the tape was recorded with
 
-void DrawVideoDisplay(unsigned long, unsigned long);
+  char *level_identifier;
+  int level_nr;
+  unsigned int random_seed;
+  unsigned int date;
+  unsigned int counter;
+  unsigned int length;
+  unsigned int length_frames;
+  unsigned int length_seconds;
+  unsigned int delay_played;
+  boolean pause_before_end;
+  boolean recording, playing, pausing;
+  boolean fast_forward;
+  boolean warp_forward;
+  boolean deactivate_display;
+  boolean auto_play;
+  boolean auto_play_level_solved;
+  boolean quick_resume;
+  boolean single_step;
+  boolean changed;
+  boolean player_participates[MAX_PLAYERS];
+  int num_participating_players;
+  int centered_player_nr_next;
+  boolean set_centered_player;
+
+  boolean use_mouse;
+
+  struct
+  {
+    byte action[MAX_PLAYERS];
+    byte delay;
+  } pos[MAX_TAPE_LEN];
+
+  struct TapeButtonInfo button;
+  struct TapeSymbolInfo symbol;
+  struct TapeLabelInfo label;
+  struct TapeTextInfo text;
+
+  boolean show_game_buttons;   // show game buttons in tape viewport
+
+  boolean no_valid_file;       // set when tape file missing or invalid
+};
+
+
+void DrawVideoDisplay(unsigned int, unsigned int);
 void DrawCompleteVideoDisplay(void);
 
-void TapeStartRecording(void);
+void TapeDeactivateDisplayOn(void);
+void TapeDeactivateDisplayOff(boolean);
+
+void TapeSetDateFromEpochSeconds(time_t);
+void TapeSetDateFromNow(void);
+
+void TapeStartRecording(int);
+void TapeHaltRecording(void);
 void TapeStopRecording(void);
+boolean TapeAddAction(byte *);
 void TapeRecordAction(byte *);
-void TapeRecordDelay(void);
-void TapeTogglePause(void);
+void TapeTogglePause(boolean);
 void TapeStartPlaying(void);
 void TapeStopPlaying(void);
 byte *TapePlayAction(void);
-boolean TapePlayDelay(void);
 void TapeStop(void);
 void TapeErase(void);
-unsigned int GetTapeLength(void);
+unsigned int GetTapeLengthFrames(void);
+unsigned int GetTapeLengthSeconds(void);
+void TapeQuickSave(void);
+void TapeQuickLoad(void);
+
+boolean hasSolutionTape(void);
+boolean InsertSolutionTape(void);
+boolean PlaySolutionTape(void);
+
+void AutoPlayTape(void);
+
+void CreateTapeButtons(void);
+void FreeTapeButtons(void);
+void MapTapeEjectButton(void);
+void MapTapeWarpButton(void);
+void MapTapeButtons(void);
+void UnmapTapeButtons(void);
+void RedrawTapeButtons(void);
+void RedrawOrRemapTapeButtons(void);
 
-void CreateTapeButtons();
-void MapTapeButtons();
-void UnmapTapeButtons();
+void HandleTapeButtonKeys(Key);
 
 #endif