From e3de403c9fed021012857f6ff63ee1750a2238b3 Mon Sep 17 00:00:00 2001
From: bnnm <bananaman255@gmail.com>
Date: Sun, 3 Dec 2017 01:41:25 +0100
Subject: [PATCH] Add Ultima IX .FLX (EA-XA/PCM)

---
 fb2k/foo_filetypes.h             |  1 +
 src/formats.c                    |  3 +
 src/libvgmstream.vcproj          |  4 ++
 src/libvgmstream.vcxproj         |  1 +
 src/libvgmstream.vcxproj.filters |  3 +
 src/meta/flx.c                   | 98 ++++++++++++++++++++++++++++++++
 src/meta/meta.h                  |  2 +
 src/vgmstream.c                  |  1 +
 src/vgmstream.h                  |  1 +
 9 files changed, 114 insertions(+)
 create mode 100644 src/meta/flx.c

diff --git a/fb2k/foo_filetypes.h b/fb2k/foo_filetypes.h
index 39199c81..160a5c81 100644
--- a/fb2k/foo_filetypes.h
+++ b/fb2k/foo_filetypes.h
@@ -116,6 +116,7 @@ VGMSTREAM_DECLARE_FILE_TYPE("EXA", exa);
 VGMSTREAM_DECLARE_FILE_TYPE("FAG", fag);
 VGMSTREAM_DECLARE_FILE_TYPE("FFW", ffw);
 VGMSTREAM_DECLARE_FILE_TYPE("FILP", filp);
+VGMSTREAM_DECLARE_FILE_TYPE("FLX", flx);
 VGMSTREAM_DECLARE_FILE_TYPE("FSB", fsb);
 VGMSTREAM_DECLARE_FILE_TYPE("FWAV", fwav);
 
diff --git a/src/formats.c b/src/formats.c
index 736f2249..515ee983 100644
--- a/src/formats.c
+++ b/src/formats.c
@@ -110,6 +110,7 @@ static const char* extension_list[] = {
     "fag",
     "ffw",
     "filp",
+    "flx",
     "fsb",
     "fwav",
 
@@ -915,6 +916,8 @@ static const meta_info meta_info_list[] = {
         {meta_EA_SNR_SNS,           "Electronic Arts SNR+SNS header"},
         {meta_EA_SPS,               "Electronic Arts SPS header"},
         {meta_NGC_VID1,             "Neversoft VID1 header"},
+        {meta_PC_FLX,               "Ultima IX .FLX header"},
+
 
 #ifdef VGM_USE_VORBIS
         {meta_OGG_VORBIS,           "Ogg Vorbis"},
diff --git a/src/libvgmstream.vcproj b/src/libvgmstream.vcproj
index 2cccd04f..921d1306 100644
--- a/src/libvgmstream.vcproj
+++ b/src/libvgmstream.vcproj
@@ -384,6 +384,10 @@
 					RelativePath=".\meta\ffw.c"
 					>
 				</File>
+                <File
+                    RelativePath=".\meta\flx.c"
+                    >
+                </File>
 				<File
 					RelativePath=".\meta\fsb.c"
 					>
diff --git a/src/libvgmstream.vcxproj b/src/libvgmstream.vcxproj
index a6768127..66c6e078 100644
--- a/src/libvgmstream.vcxproj
+++ b/src/libvgmstream.vcxproj
@@ -229,6 +229,7 @@
     <ClCompile Include="meta\emff.c" />
     <ClCompile Include="meta\exakt_sc.c" />
     <ClCompile Include="meta\ffw.c" />
+    <ClCompile Include="meta\flx.c" />
     <ClCompile Include="meta\fsb.c" />
     <ClCompile Include="meta\fsb5.c" />
     <ClCompile Include="meta\gca.c" />
diff --git a/src/libvgmstream.vcxproj.filters b/src/libvgmstream.vcxproj.filters
index 71301169..d0c364e0 100644
--- a/src/libvgmstream.vcxproj.filters
+++ b/src/libvgmstream.vcxproj.filters
@@ -223,6 +223,9 @@
     <ClCompile Include="meta\ffw.c">
       <Filter>meta\Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="meta\flx.c">
+      <Filter>meta\Source Files</Filter>
+    </ClCompile>
     <ClCompile Include="meta\fsb.c">
       <Filter>meta\Source Files</Filter>
     </ClCompile>
diff --git a/src/meta/flx.c b/src/meta/flx.c
new file mode 100644
index 00000000..acf07ac8
--- /dev/null
+++ b/src/meta/flx.c
@@ -0,0 +1,98 @@
+#include "meta.h"
+#include "../coding/coding.h"
+
+/* FLX - from Ultima IX (.FLX is actually an archive format with sometimes sound data, let's support both anyway) */
+VGMSTREAM * init_vgmstream_flx(STREAMFILE *streamFile) {
+    VGMSTREAM * vgmstream = NULL;
+    off_t start_offset, stream_offset = 0;
+    size_t data_size;
+    int loop_flag, channel_count, codec;
+    int total_streams = 0, target_stream = streamFile->stream_index;
+
+
+    /* check extensions (.flx: name of archive, files inside don't have extensions) */
+    if (!check_extensions(streamFile,"flx"))
+        goto fail;
+
+    /* all spaces up to 0x50 = archive FLX */
+    if (read_32bitBE(0x00,streamFile) == 0x20202020 && read_32bitBE(0x40,streamFile) == 0x20202020) {
+        int i;
+        int entries = read_32bitLE(0x50,streamFile);
+        off_t offset = 0x80;
+
+        if (read_32bitLE(0x54,streamFile) != 0x02
+                || read_32bitLE(0x58,streamFile) != get_streamfile_size(streamFile))
+            goto fail;
+
+        if (target_stream == 0) target_stream = 1;
+
+        for (i = 0; i < entries; i++) {
+            off_t entry_offset = read_32bitLE(offset + 0x00, streamFile);
+            /* 0x04: stream size */
+            offset += 0x08;
+
+            if (entry_offset != 0x00)
+                total_streams++; /* many entries are empty */
+            if (total_streams == target_stream && stream_offset == 0)
+                stream_offset = entry_offset; /* found but let's keep adding total_streams */
+        }
+        if (target_stream < 0 || target_stream > total_streams || total_streams < 1) goto fail;
+        if (stream_offset == 0x00) goto fail;
+    }
+    else {
+        stream_offset = 0x00;
+    }
+
+    if (read_32bitLE(stream_offset + 0x30,streamFile) != 0x10)
+        goto fail;
+    data_size = read_32bitLE(stream_offset + 0x28,streamFile);
+    channel_count = read_32bitLE(stream_offset + 0x34,streamFile);
+    codec = read_32bitLE(stream_offset + 0x38,streamFile);
+    loop_flag = (channel_count > 1); /* full seamless repeats in music */
+    start_offset = stream_offset + 0x3c;
+    /* 0x00: id */
+
+    /* build the VGMSTREAM */
+    vgmstream = allocate_vgmstream(channel_count,loop_flag);
+    if (!vgmstream) goto fail;
+
+    vgmstream->sample_rate = read_32bitLE(stream_offset + 0x2c,streamFile);
+    vgmstream->num_streams = total_streams;
+    vgmstream->meta_type = meta_PC_FLX;
+
+    switch(codec) {
+        case 0x00:  /* PCM */
+            vgmstream->coding_type = coding_PCM16LE;
+            vgmstream->layout_type = layout_interleave;
+            vgmstream->interleave_block_size = 0x02;
+
+            vgmstream->num_samples = pcm_bytes_to_samples(data_size, channel_count, 16);
+            break;
+
+        case 0x01:  /* EA-XA (music) */
+            vgmstream->coding_type = channel_count > 1 ? coding_EA_XA : coding_EA_XA_int;
+            vgmstream->layout_type = layout_none;
+
+            vgmstream->num_samples = read_32bitLE(stream_offset + 0x28,streamFile) / 0x0f*channel_count * 28; /* ea_xa_bytes_to_samples */
+            vgmstream->loop_start_sample = 0;
+            vgmstream->loop_end_sample = vgmstream->num_samples;
+            break;
+
+        case 0x02:  /* EA-MT (voices) */
+        default:
+            VGM_LOG("FLX: unknown codec 0x%x\n", codec);
+            goto fail;
+    }
+
+    read_string(vgmstream->stream_name,0x20+1, stream_offset + 0x04,streamFile);
+
+
+    /* open the file for reading */
+    if ( !vgmstream_open_stream(vgmstream, streamFile, start_offset) )
+        goto fail;
+    return vgmstream;
+
+fail:
+    close_vgmstream(vgmstream);
+    return NULL;
+}
diff --git a/src/meta/meta.h b/src/meta/meta.h
index 9ac639a9..9fc0fa43 100644
--- a/src/meta/meta.h
+++ b/src/meta/meta.h
@@ -701,4 +701,6 @@ VGMSTREAM * init_vgmstream_ea_sps(STREAMFILE * streamFile);
 
 VGMSTREAM * init_vgmstream_ngc_vid1(STREAMFILE * streamFile);
 
+VGMSTREAM * init_vgmstream_flx(STREAMFILE * streamFile);
+
 #endif /*_META_H*/
diff --git a/src/vgmstream.c b/src/vgmstream.c
index 7da50b27..48f25cc4 100644
--- a/src/vgmstream.c
+++ b/src/vgmstream.c
@@ -370,6 +370,7 @@ VGMSTREAM * (*init_vgmstream_functions[])(STREAMFILE *streamFile) = {
     init_vgmstream_ea_snr_sns,
     init_vgmstream_ea_sps,
     init_vgmstream_ngc_vid1,
+    init_vgmstream_flx,
 
     init_vgmstream_txth,  /* should go at the end (lower priority) */
 #ifdef VGM_USE_FFMPEG
diff --git a/src/vgmstream.h b/src/vgmstream.h
index a6861a32..909d7056 100644
--- a/src/vgmstream.h
+++ b/src/vgmstream.h
@@ -633,6 +633,7 @@ typedef enum {
     meta_EA_SNR_SNS,        /* Electronic Arts SNR+SNS (Burnout Paradise) */
     meta_EA_SPS,            /* Electronic Arts SPS (Burnout Crash) */
     meta_NGC_VID1,          /* Neversoft .ogg (Gun GC) */
+    meta_PC_FLX,            /* Ultima IX PC */
 
 #ifdef VGM_USE_VORBIS
     meta_OGG_VORBIS,        /* Ogg Vorbis */