WIP mod support

CMakeLists.txt

@@ -411,10 +411,10 @@ endif()
 
 # Make sure libraries are linked
 target_link_libraries(openomf PRIVATE ${CORELIBS})
-target_link_libraries(openomf PRIVATE openomf::argtable openomf::SDL2main openomf::epoxy)
+target_link_libraries(openomf PRIVATE openomf::argtable openomf::zip openomf::SDL2main openomf::epoxy)
 foreach(TARGET ${TOOL_TARGET_NAMES})
     target_link_libraries(${TARGET} PRIVATE ${CORELIBS})
-    target_link_libraries(${TARGET} PRIVATE openomf::argtable openomf::SDL2main openomf::epoxy)
+    target_link_libraries(${TARGET} PRIVATE openomf::argtable openomf::zip openomf::SDL2main openomf::epoxy)
 endforeach()
 
 # Testing stuff
@@ -462,7 +462,8 @@ set(DOC_FILES
     README.md
     LICENSE
     resources/gamecontrollerdb/LICENSE.gamecontrollerdb
-    src/vendored/LICENSE.argtable3
+    src/vendored/argtable/LICENSE.argtable3
+    src/vendored/zip/LICENSE.zip
 )
 
 # Installation

README.md

@@ -39,7 +39,8 @@ for more information.
 
 OpenOMF contains pieces of other software, which have licenses of their own:
 - resources/gamecontrollerdb.txt is under [zlib license](resources/gamecontrollerdb/LICENSE.gamecontrollerdb)
-- src/vendored/argtable3 is under multiple licenses, please see [LICENSE](src/vendored/LICENSE.argtable3)
+- src/vendored/argtable3 is under multiple licenses, please see [LICENSE](src/vendored/argtable/LICENSE.argtable3)
+- src/vendored/zip and miniz is under the MIT license, please see [LICENSE](src/vendored/zip/LICENSE.zip)
 
 And finally, the icon resources in resources/icons fall under CC-BY 4.0 license; please see 
 [LICENSE](resources/icons/LICENSE) and https://creativecommons.org/licenses/by/4.0/ for details.

cmake-scripts/Dependencies.cmake

@@ -40,7 +40,11 @@ endif()
 
 # argtable
 add_library(openomf::argtable INTERFACE IMPORTED)
-target_include_directories(openomf::argtable INTERFACE "${CMAKE_SOURCE_DIR}/src/vendored")
+target_include_directories(openomf::argtable INTERFACE "${CMAKE_SOURCE_DIR}/src/vendored/argtable")
+
+# zip
+add_library(openomf::zip INTERFACE IMPORTED)
+target_include_directories(openomf::zip INTERFACE "${CMAKE_SOURCE_DIR}/src/vendored/zip")
 
 # enet
 add_library(openomf::enet INTERFACE IMPORTED)

src/audio/audio.c

@@ -2,11 +2,14 @@
 #include "audio/backends/audio_backend.h"
 #include "audio/sources/opus_source.h"
 #include "audio/sources/psm_source.h"
+#include "game/utils/settings.h"
+#include "resources/modmanager.h"
 #include "resources/resource_files.h"
 #include "resources/sounds_loader.h"
 #include "utils/c_array_util.h"
 #include "utils/log.h"
 #include "utils/path.h"
+#include "utils/random.h"
 
 #include <assert.h>
 
@@ -212,31 +215,22 @@ static void load_xmp_music(const char *src) {
     }
 }
 
-static void load_opus_music(const char *src) {
+static void load_opus_music(unsigned char *buf, size_t len) {
     music_source music;
     unsigned channels;
     unsigned sample_rate;
     current_backend.get_info(current_backend.ctx, &sample_rate, &channels, NULL);
-    if(opus_load(&music, channels, sample_rate, src)) {
+    if(opus_load_memory(&music, channels, sample_rate, buf, len)) {
         current_backend.play_music(current_backend.ctx, &music);
     }
 }
 
 static path get_music_path(music_file_type *type, unsigned int resource_id) {
     assert(is_music(resource_id));
-    path original_music, new_music;
-    original_music = new_music = get_resource_filename(get_resource_file(resource_id));
-    path_set_ext(&new_music, ".ogg");
-
-    if(path_exists(&new_music)) {
-        log_debug("Found alternate music file %s", path_c(&new_music));
-        *type = MUSIC_FILE_TYPE_OGG;
-        return new_music;
-    } else {
-        log_debug("Found original music file %s", path_c(&original_music));
-        *type = MUSIC_FILE_TYPE_PSM;
-        return original_music;
-    }
+    path original_music;
+    original_music = get_resource_filename(get_resource_file(resource_id));
+    *type = MUSIC_FILE_TYPE_PSM;
+    return original_music;
 }
 
 void audio_play_music(resource_id id) {
@@ -245,12 +239,28 @@ void audio_play_music(resource_id id) {
         const path music = get_music_path(&file_type, id);
 
         switch(file_type) {
-            case MUSIC_FILE_TYPE_PSM:
-                load_xmp_music(path_c(&music));
-                break;
-            case MUSIC_FILE_TYPE_OGG:
-                load_opus_music(path_c(&music));
+            case MUSIC_FILE_TYPE_PSM: {
+                str fn;
+                unsigned char *buf;
+                size_t len;
+                // check the modmanager here for a music mod
+                path_stem(&music, &fn);
+                int music_count = modmanager_count_music(&fn);
+                int rand = rand_int(music_count + 1);
+                int music_type = settings_get()->sound.music_type;
+                if(music_count > 0 && music_type == 1 && rand == 0) {
+                    // remixes only, never select an original track (0)
+                    rand = rand_int(music_count) + 1;
+                }
+                if(music_type != 0 && rand && modmanager_get_music(&fn, rand - 1, &buf, &len)) {
+                    log_debug("found replacement music file for %s.PSM", str_c(&fn));
+                    load_opus_music(buf, len);
+                } else {
+                    log_debug("Found original music file %s", path_c(&music));
+                    load_xmp_music(path_c(&music));
+                }
                 break;
+            }
             default:
                 log_error("Unable to load music file %s due to unsupported audio format", path_c(&music));
                 break;

src/audio/sources/opus_source.c

@@ -88,6 +88,31 @@ bool opus_load(music_source *src, int channels, int sample_rate, const char *fil
     return false;
 }
 
+bool opus_load_memory(music_source *src, int channels, int sample_rate, const unsigned char *buffer, size_t buflen) {
+    opus_source *context = omf_calloc(1, sizeof(opus_source));
+    rb_create(&context->buffer, RING_SIZE);
+    if((context->handle = op_open_memory(buffer, buflen, NULL)) == NULL) {
+        log_error("Failed to open opus file");
+        goto exit_0;
+    }
+    if(SDL_BuildAudioCVT(&context->cvt, AUDIO_S16, 2, 48000, AUDIO_S16, channels, sample_rate) < 0) {
+        log_error("Audio converter creation failed: %s", SDL_GetError());
+        goto exit_1;
+    }
+
+    src->context = context;
+    src->set_volume = opus_set_volume;
+    src->render = opus_render;
+    src->close = opus_close;
+    return true;
+
+exit_1:
+    op_free(context->handle);
+exit_0:
+    omf_free(context);
+    return false;
+}
+
 #else
 
 bool opus_load(music_source *src, int channels, int sample_rate, const char *file) {

src/audio/sources/opus_source.h

@@ -6,5 +6,6 @@
 #include "audio/sources/music_source.h"
 
 bool opus_load(music_source *src, int channels, int sample_rate, const char *file);
+bool opus_load_memory(music_source *src, int channels, int sample_rate, const unsigned char *buffer, size_t buflen);
 
 #endif // OPUS_SOURCE_H

src/engine.c

@@ -8,6 +8,7 @@
 #include "game/game_state.h"
 #include "game/utils/settings.h"
 #include "resources/languages.h"
+#include "resources/modmanager.h"
 #include "resources/resource_files.h"
 #include "resources/resource_paths.h"
 #include "resources/sounds_loader.h"
@@ -78,6 +79,9 @@ int engine_init(engine_init_flags *init_flags) {
     if(!console_init()) {
         goto exit_6;
     }
+    if(!modmanager_init()) {
+        goto exit_7;
+    }
     vga_state_init();
 
     // Return successfully
@@ -86,6 +90,8 @@ int engine_init(engine_init_flags *init_flags) {
     return 0;
 
     // If something failed, close in correct order
+exit_7:
+    console_close();
 exit_6:
     altpals_close();
 exit_5:
@@ -409,5 +415,6 @@ void engine_close(void) {
     audio_close();
     video_close();
     vga_state_close();
+    modmanager_shutdown();
     log_info("Engine deinit successful.");
 }

src/formats/chr.c

@@ -14,6 +14,7 @@
 #include "formats/tournament.h"
 #include "game/scenes/mechlab/har_economy.h"
 #include "game/scenes/mechlab/lab_menu_customize.h"
+#include "resources/modmanager.h"
 #include "resources/resource_files.h"
 #include "resources/trnmanager.h"
 #include "utils/allocator.h"
@@ -94,17 +95,6 @@ int sd_chr_load(sd_chr_file *chr, const path *filename) {
         log_error("failed to load tournament image from %s", path_c(&image_path));
     }
 
-    // Load PIC file and make a surface
-    const path players_path = get_resource_filename("PLAYERS.PIC");
-    sd_pic_create(&players);
-    const int ret = sd_pic_load(&players, &players_path);
-    if(ret == SD_SUCCESS) {
-        // Load player gender from PLAYERS.PIC
-        const sd_pic_photo *photo = sd_pic_get(&players, chr->pilot.photo_id);
-        chr->pilot.sex = photo->sex;
-        sd_pic_free(&players);
-    }
-
     if(*chr->pilot.trn_name != '\0') {
         trn_loaded = trn_load(&trn, chr->pilot.trn_name) == 0;
     }
@@ -139,7 +129,12 @@ int sd_chr_load(sd_chr_file *chr, const path *filename) {
         if(trn_loaded) {
             memcpy(&chr->enemies[i]->pilot.palette, &pic.photos[trn.enemies[i]->photo_id]->pal, sizeof(vga_palette));
             chr->enemies[i]->pilot.photo = omf_calloc(1, sizeof(sd_sprite));
-            sd_sprite_copy(chr->enemies[i]->pilot.photo, pic.photos[trn.enemies[i]->photo_id]->sprite);
+            if(trn.enemies[i]->photo) {
+                log_info("using pilot photo %d from tournament", i);
+                sd_sprite_copy(chr->enemies[i]->pilot.photo, trn.enemies[i]->photo);
+            } else {
+                sd_sprite_copy(chr->enemies[i]->pilot.photo, pic.photos[trn.enemies[i]->photo_id]->sprite);
+            }
             //  copy all the "pilot" fields (eg. winnings) over from the tournament file
             chr->enemies[i]->pilot.trn_rank_money = trn.enemies[i]->trn_rank_money;
             chr->enemies[i]->pilot.trn_winnings_mult = trn.enemies[i]->trn_winnings_mult;
@@ -225,6 +220,20 @@ int sd_chr_load(sd_chr_file *chr, const path *filename) {
 
     chr->pilot.photo = chr->photo;
 
+    // Load PIC file and make a surface
+    const path players_path = get_resource_filename("PLAYERS.PIC");
+    sd_pic_create(&players);
+    const int ret = sd_pic_load(&players, &players_path);
+    if(ret == SD_SUCCESS) {
+        modmanager_get_player_pics(&players);
+        // Load player gender from PLAYERS.PIC
+        const sd_pic_photo *photo = sd_pic_get(&players, chr->pilot.photo_id);
+        chr->pilot.sex = photo->sex;
+        chr->pilot.photo->render_width = photo->sprite->render_width;
+        chr->pilot.photo->render_height = photo->sprite->render_height;
+        sd_pic_free(&players);
+    }
+
     // Load colors from other files
     sd_pilot_set_player_color(&chr->pilot, PRIMARY, chr->pilot.color_1);
     sd_pilot_set_player_color(&chr->pilot, SECONDARY, chr->pilot.color_2);

src/formats/pilot.c

@@ -4,6 +4,7 @@
 #include "formats/error.h"
 #include "formats/pic.h"
 #include "formats/pilot.h"
+#include "resources/modmanager.h"
 #include "resources/resource_files.h"
 #include "utils/allocator.h"
 #include "utils/c_string_util.h"
@@ -350,6 +351,7 @@ void sd_pilot_set_player_color(sd_pilot *pilot, player_color index, uint8_t colo
         sd_pic_create(&players);
         int ret = sd_pic_load(&players, &players_filename);
         if(ret == SD_SUCCESS) {
+            modmanager_get_player_pics(&players);
             // Load player palette from PLAYERS.PIC
             const sd_pic_photo *photo = sd_pic_get(&players, pilot->photo_id);
             if(photo) {

src/formats/sprite.c

@@ -29,6 +29,9 @@ int sd_sprite_copy(sd_sprite *dst, const sd_sprite *src) {
     dst->missing = src->missing;
     dst->width = src->width;
     dst->height = src->height;
+    dst->render_width = src->render_width;
+    dst->render_height = src->render_height;
+
     dst->len = src->len;
 
     if(src->data != NULL) {
@@ -57,6 +60,8 @@ int sd_sprite_load(sd_reader *r, sd_sprite *sprite) {
     sprite->pos_y = sd_read_word(r);
     sprite->width = sd_read_uword(r);
     sprite->height = sd_read_uword(r);
+    sprite->render_height = sprite->height;
+    sprite->render_width = sprite->width;
     sprite->index = sd_read_ubyte(r);
     sprite->missing = sd_read_ubyte(r);
 
@@ -202,7 +207,7 @@ int sd_sprite_rgba_encode(sd_sprite *dst, const sd_rgba_image *src, const vga_pa
 int sd_sprite_rgba_decode(sd_rgba_image *dst, const sd_sprite *src, const vga_palette *pal) {
     uint16_t x = 0;
     uint16_t y = 0;
-    int i = 0;
+    uint32_t i = 0;
     uint16_t c = 0;
     uint16_t data = 0;
     char op = 0;
@@ -269,7 +274,7 @@ int sd_sprite_rgba_decode(sd_rgba_image *dst, const sd_sprite *src, const vga_pa
 int sd_sprite_vga_decode(sd_vga_image *dst, const sd_sprite *src) {
     uint16_t x = 0;
     uint16_t y = 0;
-    int i = 0;
+    uint32_t i = 0;
     uint16_t c = 0;
     uint16_t data = 0;
     char op = 0;
@@ -311,7 +316,7 @@ int sd_sprite_vga_decode(sd_vga_image *dst, const sd_sprite *src) {
                 y = data;
                 break;
             case 1:
-                while(data > 0) {
+                while(data > 0 && i < src->len) {
                     uint8_t b = src->data[i];
                     unsigned int pos = ((y * src->width) + x);
                     // if we're about to overflow the `dst` buffer, don't.
@@ -422,6 +427,9 @@ int sd_sprite_vga_encode(sd_sprite *dst, const sd_vga_image *src) {
     // Copy data
     dst->width = src->w;
     dst->height = src->h;
+    dst->render_width = src->w;
+    dst->render_height = src->h;
+
     dst->len = i;
     dst->missing = 0;
     dst->data = omf_calloc(i, 1);

src/formats/sprite.h

@@ -31,8 +31,10 @@ typedef struct {
     uint8_t missing; ///< Is sprite data missing? If this is 1, then data points to the data of another sprite.
     uint16_t width;  ///< Pixel width of the sprite
     uint16_t height; ///< Pixel height of the sprite
-    uint16_t len;    ///< Byte length of the packed sprite data
-    char *data;      ///< Packed sprite data
+    uint16_t render_width;
+    uint16_t render_height;
+    uint32_t len; ///< Byte length of the packed sprite data
+    char *data;   ///< Packed sprite data
 } sd_sprite;
 
 /*! \brief Initialize sprite structure

src/formats/tournament.c

@@ -73,7 +73,7 @@ int sd_tournament_set_pic_name(sd_tournament_file *trn, const char *pic_name) {
     return SD_SUCCESS;
 }
 
-static void parse_tournament_description(sd_tournament_locale *locale) {
+void parse_tournament_description(sd_tournament_locale *locale) {
     int width = 320, center = 0, vmove = 0, size = -1, color = -1;
     const char *desc = locale->description;
     const char *end = desc;

src/formats/tournament.h

@@ -127,4 +127,13 @@ int sd_tournament_set_pic_name(sd_tournament_file *trn, const char *pic_name);
  */
 void sd_tournament_free(sd_tournament_file *trn);
 
+/*! \brief Parse the tournament description
+ *
+ * Parses the tournament description tags into the locale struct
+ *
+ * \param trn TRN locale pointer.
+ */
+
+void parse_tournament_description(sd_tournament_locale *locale);
+
 #endif // SD_TOURNAMENT_H