valid C comments
[neverball] / ball / demo.c
index d25d25e..65feb19 100644 (file)
@@ -1,4 +1,4 @@
-/*   
+/*
  * Copyright (C) 2003 Robert Kooima
  *
  * NEVERBALL is  free software; you can redistribute  it and/or modify
 #include <unistd.h>
 #endif
 
-#include "set.h"
 #include "demo.h"
 #include "game.h"
-#include "level.h"
 #include "audio.h"
 #include "solid.h"
 #include "config.h"
 
 /*---------------------------------------------------------------------------*/
 
-#define MAGIC 0x4E425252
+#define MAGIC     0x4E425251 /* Replay file magic number (should not change) */
+#define OLD_MAGIC 0x4E425250 /* Replay file magic number for neverball 1.4.0 */
+#define REPLAY_VERSION  1    /* Replay file format version (can change)      */
+
 #define DEMO_FPS_CAP 200 /* FPS replay limit, keeps size down on monster systems */
 
 static FILE *demo_fp;
 
-
-/* Demo information structure (header) */
-struct demo
-{
-    char   name[MAXNAM];    /* demo filename */
-
-    /* magic */
-    int    timer;           /* elapsed time */
-    int    coins;           /* coin number */
-    int    state;           /* how the replay end */
-    int    mode;            /* game mode */
-    time_t date;            /* date of creation */
-    char   player[MAXNAM];  /* player name */
-    char   shot[PATHMAX];   /* image filename */
-    char   file[PATHMAX];   /* level filename */
-    char   back[PATHMAX];   /* level bg filename */
-    char   grad[PATHMAX];   /* level gradiant filename */
-    char   song[PATHMAX];   /* level song filename */
-    int    time;            /* time limit (! training mode) */
-    int    goal;            /* coin to open the goal (! training mode) */
-    int    score;           /* sum of coins (challenge mode) */
-    int    balls;           /* number of balls (challenge mode) */
-    int    total_time;      /* total time (challenge mode) */
-};
-
-
 static struct demo demos[MAXDEMO]; /* Array of scanned demos */
 
 static int count; /* number of scanned demos */
 
 /*---------------------------------------------------------------------------*/
 
-void demo_dump_info(struct demo * d)
-/* This function dump the info of a demo structure*/
+void demo_dump_info(const struct demo *d)
+/* This function dump the info of a demo structure
+ * It's only a function for debugging, no need of I18N */
 {
-    printf("Filename: %s\n"
-          "Time:     %d\n"
-          "Coins:    %d\n"
-          "Mode:     %d\n"
-          "State:    %d\n"
-          "Date:     %s"
-          "Player:   %s\n"
-          "Shot:     %s\n"
-          "Level:    %s\n"
-          "  Back:   %s\n"
-          "  Grad:   %s\n"
-          "  Song:   %s\n"
-          "Time:     %d\n"
-          "Goal:     %d\n"
-          "Score:    %d\n"
-          "Balls:    %d\n"
-          "Tot Time: %d\n",
-          d->name,
-          d->timer, d->coins, d->mode, d->state, ctime(&d->date),
-          d->player,
-          d->shot, d->file, d->back, d->grad, d->song,
-          d->time, d->goal, d->score, d->balls, d->total_time);
+    printf("Name:         %s\n"
+           "File:         %s\n"
+           "NB Version:   %s\n"
+           "Time:         %d\n"
+           "Coins:        %d\n"
+           "Mode:         %d\n"
+           "State:        %d\n"
+           "Date:         %s"
+           "Player:       %s\n"
+           "Shot:         %s\n"
+           "Level:        %s\n"
+           "  Back:       %s\n"
+           "  Grad:       %s\n"
+           "  Song:       %s\n"
+           "Time:         %d\n"
+           "Goal:         %d\n"
+           "Score:        %d\n"
+           "Balls:        %d\n"
+           "Total Time:   %d\n",
+           d->name, d->filename,
+           d->nb_version,
+           d->timer, d->coins, d->mode, d->state, ctime(&d->date),
+           d->player,
+           d->shot, d->file, d->back, d->grad, d->song,
+           d->time, d->goal, d->score, d->balls, d->times);
 }
 
-static FILE * demo_header(const char * filename, struct demo * d)
+FILE *demo_header_read(const char *filename, struct demo *d)
 /* Open a demo file, fill the demo information structure
-If success, return the file pointer positioned after the header
-If fail, return null */
+ * If success, return the file pointer positioned after the header
+ * If fail, return null
+ */
+{
+    FILE *fp;
+    char *basename;
+    char buf[MAXSTR];
+
+    if ((fp = fopen(filename, FMODE_RB)))
+    {
+        int magic;
+        int version;
+        int t;
+
+        get_index(fp, &magic);
+        get_index(fp, &version);
+
+        /* if time is 0, it means the replay was not finished */
+        get_index(fp, &t);
+
+        if (magic == MAGIC && version == REPLAY_VERSION && t)
+        {
+            d->timer = t;
+            strncpy(d->filename, filename, PATHMAX);
+
+            /* Remove the directory delimiter */
+            basename = strrchr(filename, '/');
+
+            if (basename != NULL)
+                strncpy(buf, basename + 1, MAXSTR);
+            else
+                strncpy(buf, filename, MAXSTR);
+
+            /* Remove the extension */
+            t = strlen(buf) - strlen(REPLAY_EXT);
+            if ((t > 1) && (strcmp(buf + t, REPLAY_EXT) == 0))
+                buf[t] = '\0';
+            strncpy(d->name, buf, PATHMAX);
+            d->name[PATHMAX - 1] = '\0';
+
+            get_index (fp, &d->coins);
+            get_index (fp, &d->state);
+            get_index (fp, &d->mode);
+            get_index (fp, (int *)&d->date);
+            get_string(fp, d->player, MAXNAM);
+            get_string(fp, d->shot,   PATHMAX);
+            get_string(fp, d->file,   PATHMAX);
+            get_string(fp, d->back,   PATHMAX);
+            get_string(fp, d->grad,   PATHMAX);
+            get_string(fp, d->song,   PATHMAX);
+            get_index (fp, &d->time);
+            get_index (fp, &d->goal);
+            get_index (fp, &d->score);
+            get_index (fp, &d->balls);
+            get_index (fp, &d->times);
+            get_string(fp, d->nb_version, 20);
+
+            return fp;
+        }
+        fclose(fp);
+    }
+    return NULL;
+}
+
+static FILE *demo_header_write(struct demo *d)
+/* Create a new demo file, write the demo information structure
+ * If success, return the file pointer positioned after the header
+ * If fail, return null
+ * */
 {
+    int magic = MAGIC;
+    int version = REPLAY_VERSION;
+    int zero  = 0;
     FILE *fp;
-    if ((fp = fopen(config_user(filename), FMODE_RB)))
+
+    if (d->filename && (fp = fopen(d->filename, FMODE_WB)))
     {
-       int magic;
-       int t;
-
-       get_index(fp, &magic);
-       get_index(fp, &t);
-
-       if (magic == MAGIC && t)
-       {
-           strncpy(d->name, filename, MAXNAM);
-           d->timer = t;
-           get_index(fp, &d->coins);
-           get_index(fp, &d->state);
-           get_index(fp, &d->mode);
-           get_index(fp, (int*)&d->date);
-           fread(d->player, 1, MAXNAM,  fp);
-           fread(d->shot,   1, PATHMAX, fp);
-            fread(d->file,   1, PATHMAX, fp);
-            fread(d->back,   1, PATHMAX, fp);
-            fread(d->grad,   1, PATHMAX, fp);
-            fread(d->song,   1, PATHMAX, fp);
-            get_index(fp, &d->time);
-            get_index(fp, &d->goal);
-            get_index(fp, &d->score);
-            get_index(fp, &d->balls);
-            get_index(fp, &d->total_time);
-
-           return fp;
-       }
-       fclose(fp);
+        put_index (fp, &magic);
+        put_index (fp, &version);
+        put_index (fp, &zero);
+        put_index (fp, &zero);
+        put_index (fp, &zero);
+        put_index (fp, &d->mode);
+        put_index (fp, (int *)&d->date);
+        put_string(fp, d->player);
+        put_string(fp, d->shot);
+        put_string(fp, d->file);
+        put_string(fp, d->back);
+        put_string(fp, d->grad);
+        put_string(fp, d->song);
+        put_index (fp, &d->time);
+        put_index (fp, &d->goal);
+        put_index (fp, &d->score);
+        put_index (fp, &d->balls);
+        put_index (fp, &d->times);
+        put_string(fp, VERSION);
+
+        return fp;
     }
     return NULL;
 }
 
+void demo_header_stop(FILE *fp, int coins, int timer, int state)
+/* Update the demo header using the final level state. */
+{
+    long pos = ftell(fp);
+    fseek(fp, 8, SEEK_SET);
+    put_index(fp, &timer);
+    put_index(fp, &coins);
+    put_index(fp, &state);
+    fseek(fp, pos, SEEK_SET);
+}
+
 /*---------------------------------------------------------------------------*/
 
-static void demo_scan_file(const char * filename)
-/* Scan a other file (used by demo_scan */
+static void demo_scan_file(const char *filename)
+/* Scan another file (used by demo_scan */
 {
     FILE *fp;
-    if ((fp = demo_header(filename, &demos[count])))
+    if ((fp = demo_header_read(config_user(filename), &demos[count])))
     {
-       count++;
-       fclose(fp);
+        count++;
+        fclose(fp);
     }
 }
 
@@ -164,7 +217,7 @@ int demo_scan(void)
     if ((h = FindFirstFile(config_user("*"), &d)) != INVALID_HANDLE_VALUE)
     {
         do
-           demo_scan_file(d.cFileName);
+            demo_scan_file(d.cFileName);
         while (count < MAXDEMO && FindNextFile(h, &d));
 
         FindClose(h);
@@ -187,7 +240,7 @@ int demo_scan(void)
     if ((dp = opendir(config_user(""))))
     {
         while (count < MAXDEMO && (ent = readdir(dp)))
-           demo_scan_file(ent->d_name);
+            demo_scan_file(ent->d_name);
 
         closedir(dp);
     }
@@ -199,56 +252,20 @@ const char *demo_pick(void)
 {
     int n = demo_scan();
 
-    return (n > 0) ? demos[(rand() >> 4) % n].name : NULL;
-}
-
-const char *demo_name(int i)
-{
-    return (0 <= i && i < count) ? demos[i].name : NULL;
-}
-
-const char *demo_shot(int i)
-{
-    return (0 <= i && i < count) ? demos[i].shot : NULL;
-}
-
-int demo_coins(int i)
-{
-    return (0 <= i && i < count) ? demos[i].coins : 0;
-}
-
-int demo_state(int i)
-{
-    return (0 <= i && i < count) ? demos[i].state : 0;
-}
-
-int demo_mode(int i)
-{
-    return (0 <= i && i < count) ? demos[i].mode : 0;
-}
-
-int demo_clock(int i)
-{
-    return (0 <= i && i < count) ? demos[i].timer : 0;
-}
-
-time_t demo_date(int i)
-{
-    return (0 <= i && i < count) ? demos[i].date : 0;
+    return (n > 0) ? demos[(rand() >> 4) % n].filename : NULL;
 }
 
-const char * demo_str_date(int i)
+const struct demo *get_demo(int i)
 {
-    time_t d = demo_date(i);
-    char * res = ctime(&d);
-    char * n = strchr(res, '\n');
-    if (n) *n = '\0';
-    return res;
+    return (0 <= i && i < count) ? &demos[i] : NULL;
 }
 
-const char * demo_player(int i)
+const char *date_to_str(time_t i)
 {
-    return (0 <= i && i < count) ? demos[i].player : "";
+    static char str[MAXSTR];
+    struct tm *tm = localtime(&i);
+    strftime (str, MAXSTR, "%c", tm);
+    return str;
 }
 
 /*---------------------------------------------------------------------------*/
@@ -256,8 +273,11 @@ const char * demo_player(int i)
 int demo_exists(char *name)
 {
     FILE *fp;
+    char buf[MAXSTR];
 
-    if ((fp = fopen(config_user(name), "r")))
+    strcpy(buf, config_user(name));
+    strcat(buf, REPLAY_EXT);
+    if ((fp = fopen(buf, "r")))
     {
         fclose(fp);
         return 1;
@@ -283,50 +303,38 @@ void demo_unique(char *name)
 /*---------------------------------------------------------------------------*/
 
 int demo_play_init(const char *name,
-                   const char *file,
-                   const char *back,
-                   const char *grad,
-                   const char *song,
-                   const char *shot,
-                  int mode, int tim, int goal, int score, int balls, int total_time)
+                   const struct level *level,
+                   const struct level_game *lg)
 {
-    int magic = MAGIC;
-    int zero  = 0;
-    int date  = time(NULL);
-
-    char player[MAXNAM];
-    config_get_s(CONFIG_PLAYER, player, MAXNAM);
-
-    /* Initialize the replay file.  Write the header. */
-
-    if (name && (demo_fp = fopen(config_user(name), FMODE_WB)))
+    struct demo demo;
+
+    /* file structure */
+    strncpy(demo.name, name, MAXNAM);
+    strncpy(demo.filename, config_user(name), PATHMAX);
+    strcat(demo.filename, REPLAY_EXT);
+    demo.time = demo.coins = demo.state = 0;
+    demo.mode = lg->mode;
+    demo.date = time(NULL);
+    config_get_s(CONFIG_PLAYER, demo.player, MAXNAM);
+    strncpy(demo.shot, level->shot, PATHMAX);
+    strncpy(demo.file, level->file, PATHMAX);
+    strncpy(demo.back, level->back, PATHMAX);
+    strncpy(demo.grad, level->grad, PATHMAX);
+    strncpy(demo.song, level->song, PATHMAX);
+    demo.time  = lg->time;
+    demo.goal  = lg->goal;
+    demo.score = lg->score;
+    demo.balls = lg->balls;
+    demo.times = lg->times;
+
+    demo_fp = demo_header_write(&demo);
+    if (demo_fp == NULL)
+        return 0;
+    else
     {
-        put_index(demo_fp, &magic);
-        put_index(demo_fp, &zero);
-        put_index(demo_fp, &zero);
-        put_index(demo_fp, &zero);
-       put_index(demo_fp, &mode);
-       put_index(demo_fp, &date);
-
-        fwrite(player, 1, MAXNAM,  demo_fp);
-       
-        fwrite(shot,   1, PATHMAX, demo_fp);
-        fwrite(file,   1, PATHMAX, demo_fp);
-        fwrite(back,   1, PATHMAX, demo_fp);
-        fwrite(grad,   1, PATHMAX, demo_fp);
-        fwrite(song,   1, PATHMAX, demo_fp);
-
-        put_index(demo_fp, &tim);
-        put_index(demo_fp, &goal);
-        put_index(demo_fp, &score);
-        put_index(demo_fp, &balls);
-        put_index(demo_fp, &total_time);
-
-        audio_music_fade_to(2.0f, song);
-
-        return game_init(file, back, grad, tim, (goal == 0));
+        audio_music_fade_to(2.0f, level->song);
+        return game_init(level, lg->time, lg->goal);
     }
-    return 0;
 }
 
 void demo_play_step(float dt)
@@ -338,76 +346,103 @@ void demo_play_step(float dt)
     {
         fps_track += dt;
         if (fps_track > fps_cap)
-        {            
+        {
             put_float(demo_fp, &fps_track);
-            put_game_state(demo_fp); 
+            put_game_state(demo_fp);
             fps_track = 0.0f;
         }
     }
 }
 
-void demo_play_stop(int coins, int timer, int state)
+void demo_play_stop(const struct level_game *lg)
+/* Update the demo header using the final level state. */
 {
     if (demo_fp)
     {
-        /* Update the demo header using the final coins and time. */
-
-        fseek(demo_fp, 4, SEEK_SET);
-
-        put_index(demo_fp, &timer);
-        put_index(demo_fp, &coins);
-        put_index(demo_fp, &state);
-
-       fclose(demo_fp);
-       demo_fp = NULL;
+        demo_header_stop(demo_fp, lg->coins, lg->timer, lg->state);
+        fclose(demo_fp);
+        demo_fp = NULL;
     }
 }
 
+int demo_play_saved(void)
+{
+    return demo_exists(USER_REPLAY_FILE);
+}
+
 void demo_play_save(const char *name)
 {
     char src[PATHMAX];
     char dst[PATHMAX];
 
-    if (name && demo_exists(USER_REPLAY_FILE) && strcmp(name, USER_REPLAY_FILE) != 0)
+    if (name && demo_exists(USER_REPLAY_FILE)
+        && strcmp(name, USER_REPLAY_FILE) != 0)
     {
         strncpy(src, config_user(USER_REPLAY_FILE), PATHMAX);
-       strncpy(dst, config_user(name),             PATHMAX);
+        strcat(src, REPLAY_EXT);
+        strncpy(dst, config_user(name), PATHMAX);
+        strcat(dst, REPLAY_EXT);
 
-       rename(src, dst);
+        rename(src, dst);
     }
 }
 
 /*---------------------------------------------------------------------------*/
 
-static char demo_replay_name[MAXSTR];
+static int demo_load_level(const struct demo *demo, struct level *level)
+/* Load the level of the demo and fill the level structure */
+{
+    if (level_load(demo->file, level))
+    {
+        level->time = demo->time;
+        level->goal = demo->goal;
+        return 1;
+    }
+    else
+        return 0;
+}
+
+static struct demo  demo_replay;       /* The current demo */
+static struct level demo_level_replay; /* The current level demo-ed*/
 
-int demo_replay_init(const char *name, int *m, int *s, int *c, int *g, int *t)
+const struct demo *curr_demo_replay(void)
 {
-    struct demo d;
+    return &demo_replay;
+}
 
-    if ((demo_fp = demo_header(name, &d)))
+
+int demo_replay_init(const char *name, struct level_game *lg)
+/* Internally load a replay an fill the lg structure (if not NULL) */
+{
+    if ((demo_fp = demo_header_read(name, &demo_replay)))
     {
-        strncpy(demo_replay_name, name, MAXSTR);
-       if (m) *m = d.mode;
-       if (s) *s = d.score;
-       if (g) *g = d.goal;
-       if (t) *t = d.total_time;
-
-       if (g)
-       {
-           audio_music_fade_to(0.5f, d.song);
-           return game_init(d.file, d.back, d.grad, d.time, (d.goal == 0));
-       }
-       else
-           return game_init(d.file, d.back, d.grad, d.time, 1);
+        if (!demo_load_level(&demo_replay, &demo_level_replay))
+            return 0;
+
+        if (lg)
+        {
+            lg->mode = demo_replay.mode;
+            lg->score = demo_replay.score;
+            lg->times = demo_replay.times;
+            lg->time = demo_replay.time;
+            lg->goal = demo_replay.goal;
+
+            /* A normal replay demo */
+            audio_music_fade_to(0.5f, demo_replay.song);
+            return game_init(&demo_level_replay, demo_replay.time,
+                             demo_replay.goal);
+        }
+        else                    /* A title screen demo */
+            return game_init(&demo_level_replay, demo_replay.time, 0);
     }
-    
+
     return 0;
 }
 
 int demo_replay_step(float *dt)
 {
     const float g[3] = { 0.0f, -9.8f, 0.0f };
+    int sv;
 
     if (demo_fp)
     {
@@ -417,10 +452,10 @@ int demo_replay_step(float *dt)
         {
             /* Play out current game state for particles, clock, etc. */
 
-            game_step(g, *dt, 1);
+            game_step(g, *dt, &sv);
 
             /* Load real current game state from file. */
-            
+
             if (get_game_state(demo_fp))
                 return 1;
         }
@@ -435,8 +470,13 @@ void demo_replay_stop(int d)
         fclose(demo_fp);
         demo_fp = NULL;
 
-        if (d) unlink(config_user(demo_replay_name));
+        if (d) unlink(demo_replay.filename);
     }
 }
 
+void demo_replay_dump_info(void)
+{
+    demo_dump_info(&demo_replay);
+}
+
 /*---------------------------------------------------------------------------*/