Add MIDS music format playback support

include/zmusic.h

@@ -29,7 +29,8 @@ typedef enum EMIDIType_
 	MIDI_MIDI,
 	MIDI_HMI,
 	MIDI_XMI,
-	MIDI_MUS
+	MIDI_MUS,
+	MIDI_MIDS
 } EMIDIType;
 
 typedef enum EMidiDevice_

source/CMakeLists.txt

@@ -105,6 +105,7 @@ set( all_files
 	midisources/midisource_smf.cpp
 	midisources/midisource_hmi.cpp
 	midisources/midisource_xmi.cpp
+	midisources/midisource_mids.cpp
 	streamsources/music_dumb.cpp
 	streamsources/music_gme.cpp
 	streamsources/music_libsndfile.cpp

source/midisources/midisource.cpp

@@ -450,6 +450,13 @@ DLL_EXPORT EMIDIType ZMusic_IdentifyMIDIType(uint32_t *id, int size)
 	{
 		return MIDI_XMI;
 	}
+	// Check for MIDS format
+	else
+	if (id[0] == MAKE_ID('R','I','F','F') &&
+		id[2] == MAKE_ID('M','I','D','S'))
+	{
+		return MIDI_MIDS;
+	}
 	// Check for MIDI format
 	else if (id[0] == MAKE_ID('M','T','h','d'))
 	{
@@ -489,6 +496,10 @@ DLL_EXPORT ZMusic_MidiSource ZMusic_CreateMIDISource(const uint8_t *data, size_t
 		case MIDI_XMI:
 			source = new XMISong(data, length);
 			break;
+		
+		case MIDI_MIDS:
+			source = new MIDSSong(data, length);
+			break;
 
 		default:
 			SetError("Unable to identify MIDI data");

source/midisources/midisource.h

@@ -226,6 +226,25 @@ private:
 	EventSource EventDue;
 };
 
+// MIDS file played with a MIDI Stream
 
+class MIDSSong : public MIDISource
+{
+public:
+	MIDSSong(const uint8_t* data, size_t len);
+
+protected:
+	void DoInitialSetup() override;
+	void DoRestart() override;
+	bool CheckDone() override;
+	uint32_t *MakeEvents(uint32_t *events, uint32_t *max_events_p, uint32_t max_time) override;
+
+private:
+	std::vector<uint32_t> midiBuffer;
+	size_t MidsP, MaxMidsP;
+	int FormatFlags;
+
+	void ProcessInitialTempoEvents();
+};
 
 #endif /* midisources_h */

source/midisources/midisource_mids.cpp

@@ -0,0 +1,186 @@
+/*
+** midisource_mids.cpp
+** Code to let ZDoom play MIDS MIDI music through the MIDI streaming API.
+**
+**---------------------------------------------------------------------------
+** Copyright 2020 Cacodemon345
+** All rights reserved.
+**
+** Redistribution and use in source and binary forms, with or without
+** modification, are permitted provided that the following conditions
+** are met:
+**
+** 1. Redistributions of source code must retain the above copyright
+**    notice, this list of conditions and the following disclaimer.
+** 2. Redistributions in binary form must reproduce the above copyright
+**    notice, this list of conditions and the following disclaimer in the
+**    documentation and/or other materials provided with the distribution.
+** 3. The name of the author may not be used to endorse or promote products
+**    derived from this software without specific prior written permission.
+**
+** THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+** IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+** OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+** IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+** INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+** NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+** THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+**---------------------------------------------------------------------------
+**
+*/
+
+// HEADER FILES ------------------------------------------------------------
+
+#include <algorithm>
+#include "midisource.h"
+#include "zmusic/m_swap.h"
+
+// MACROS ------------------------------------------------------------------
+
+// TYPES -------------------------------------------------------------------
+
+// EXTERNAL FUNCTION PROTOTYPES --------------------------------------------
+
+// PUBLIC FUNCTION PROTOTYPES ----------------------------------------------
+
+// PRIVATE FUNCTION PROTOTYPES ---------------------------------------------
+
+// EXTERNAL DATA DECLARATIONS ----------------------------------------------
+
+// PRIVATE DATA DEFINITIONS ------------------------------------------------
+
+// PUBLIC DATA DEFINITIONS -------------------------------------------------
+
+// CODE --------------------------------------------------------------------
+
+//==========================================================================
+//
+//  MIDSSong constructor
+//
+//  Reads the buffers from the file and validates the MIDS header
+//
+//==========================================================================
+
+MIDSSong::MIDSSong(const uint8_t* data, size_t len)
+{
+    // Validate the header first.
+    if (data[12] != 'f' || data[13] != 'm' || data[14] != 't' || data[15] != ' ')
+    {        
+        return;
+    }
+    Division = LittleLong(GetInt(&data[20]));
+    FormatFlags = LittleLong(GetInt(&data[28]));
+    // Validate the data chunk.
+    if (data[32] != 'd' || data[33] != 'a' || data[34] != 't' || data[35] != 'a')
+    {
+        return;
+    }
+    int NumBlocks = LittleLong(GetInt(&data[40]));
+    const uint8_t* midiData = &data[44];
+    uint32_t tkStart = 0;
+    uint32_t cbBuffer = 0;
+    while (NumBlocks-- > 0)
+    {
+        tkStart = LittleLong(GetInt(midiData));
+        cbBuffer = LittleLong(GetInt(midiData + 4));
+        std::vector<uint32_t> midiMessageData;
+        midiMessageData.resize(cbBuffer / 4);
+        memcpy(midiMessageData.data(), midiData + 8, cbBuffer);
+        midiBuffer.insert(midiBuffer.end(), midiMessageData.begin(), midiMessageData.end());
+        midiData += 8 + cbBuffer;
+    }
+    MidsP = 0;
+    MaxMidsP = midiBuffer.size() - 1;
+    for (auto& curMidiData : midiBuffer)
+    {
+        curMidiData = LittleLong(curMidiData);
+    }
+}
+
+//==========================================================================
+//
+// MIDSSong :: DoInitialSetup
+//
+// Sets the starting channel volumes.
+//
+//==========================================================================
+
+void MIDSSong::DoInitialSetup()
+{
+	for (int i = 0; i < 16; ++i)
+	{
+		ChannelVolumes[i] = 100;
+	}
+}
+
+//==========================================================================
+//
+// MIDSSong :: CheckDone
+//
+//==========================================================================
+
+bool MIDSSong::CheckDone()
+{
+    return MidsP >= MaxMidsP;
+}
+
+//==========================================================================
+//
+// MIDSSong :: DoRestart()
+//
+// Rewinds the song
+//
+//==========================================================================
+
+void MIDSSong::DoRestart()
+{
+    MidsP = 0;
+    ProcessInitialTempoEvents();
+}
+
+//==========================================================================
+//
+// MIDSSong :: ProcessInitialTempoEvents()
+//
+// Process initial tempo events at the start of the song.
+//
+//==========================================================================
+
+void MIDSSong::ProcessInitialTempoEvents()
+{
+    if (MEVENT_EVENTTYPE(midiBuffer[FormatFlags ? 1 : 2]) == MEVENT_TEMPO)
+    {
+        SetTempo(MEVENT_EVENTPARM(midiBuffer[FormatFlags ? 1 : 2]));
+    }
+}
+
+//==========================================================================
+//
+// MUSSong2 :: MakeEvents
+//
+// Puts MIDS events into a MIDI stream
+// buffer. Returns the new position in the buffer.
+//
+//==========================================================================
+
+uint32_t* MIDSSong::MakeEvents(uint32_t* events, uint32_t* max_event_p, uint32_t max_time)
+{
+    uint32_t time = 0;
+    uint32_t tot_time = 0;
+
+    max_time = max_time * Division / Tempo;
+    while (events < max_event_p && tot_time <= max_time)
+    {
+        events[0] = time = midiBuffer[MidsP++];
+        events[1] = FormatFlags ? 0 : midiBuffer[MidsP++];
+        events[2] = midiBuffer[MidsP++];        
+        events += 3;
+        tot_time += time;
+        if (MidsP >= MaxMidsP) goto end;                
+    }
+end:
+    return events;
+}