2016-03-01 15:47:10 +00:00
|
|
|
/*
|
|
|
|
** music_midistream.cpp
|
|
|
|
** Implements base class for MIDI and MUS streaming.
|
|
|
|
**
|
|
|
|
**---------------------------------------------------------------------------
|
|
|
|
** Copyright 2008 Randy Heit
|
|
|
|
** 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 ------------------------------------------------------------
|
|
|
|
|
2017-03-10 15:12:52 +00:00
|
|
|
|
2016-03-01 15:47:10 +00:00
|
|
|
#include "i_musicinterns.h"
|
|
|
|
#include "templates.h"
|
|
|
|
#include "doomdef.h"
|
|
|
|
#include "m_swap.h"
|
|
|
|
#include "doomerrors.h"
|
|
|
|
|
|
|
|
// MACROS ------------------------------------------------------------------
|
|
|
|
|
|
|
|
#define MAX_TIME (1000000/10) // Send out 1/10 of a sec of events at a time.
|
|
|
|
|
|
|
|
|
|
|
|
// EXTERNAL FUNCTION PROTOTYPES --------------------------------------------
|
|
|
|
|
|
|
|
// PUBLIC FUNCTION PROTOTYPES ----------------------------------------------
|
|
|
|
|
|
|
|
// PRIVATE FUNCTION PROTOTYPES ---------------------------------------------
|
|
|
|
|
2017-03-10 18:46:22 +00:00
|
|
|
static void WriteVarLen (TArray<uint8_t> &file, uint32_t value);
|
2016-03-01 15:47:10 +00:00
|
|
|
|
|
|
|
// EXTERNAL DATA DECLARATIONS ----------------------------------------------
|
|
|
|
|
|
|
|
EXTERN_CVAR(Float, snd_musicvolume)
|
|
|
|
EXTERN_CVAR(Int, snd_mididevice)
|
|
|
|
|
|
|
|
#ifdef _WIN32
|
2017-03-10 15:12:52 +00:00
|
|
|
extern unsigned mididevice;
|
2016-03-01 15:47:10 +00:00
|
|
|
#endif
|
|
|
|
|
|
|
|
// PRIVATE DATA DEFINITIONS ------------------------------------------------
|
|
|
|
|
|
|
|
// PUBLIC DATA DEFINITIONS -------------------------------------------------
|
|
|
|
|
|
|
|
// CODE --------------------------------------------------------------------
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer Constructor
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
MIDIStreamer::MIDIStreamer(EMidiDevice type, const char *args)
|
|
|
|
:
|
2018-02-23 11:40:43 +00:00
|
|
|
MIDI(0), DeviceType(type), Args(args)
|
2016-03-01 15:47:10 +00:00
|
|
|
{
|
2017-03-10 11:01:29 +00:00
|
|
|
memset(Buffer, 0, sizeof(Buffer));
|
2016-03-01 15:47:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer OPL Dumping Constructor
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
MIDIStreamer::MIDIStreamer(const char *dumpname, EMidiDevice type)
|
|
|
|
:
|
2018-02-23 11:40:43 +00:00
|
|
|
MIDI(0), DeviceType(type), DumpFilename(dumpname)
|
2016-03-01 15:47:10 +00:00
|
|
|
{
|
2017-03-10 11:01:29 +00:00
|
|
|
memset(Buffer, 0, sizeof(Buffer));
|
2016-03-01 15:47:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer Destructor
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
MIDIStreamer::~MIDIStreamer()
|
|
|
|
{
|
|
|
|
Stop();
|
|
|
|
if (MIDI != NULL)
|
|
|
|
{
|
|
|
|
delete MIDI;
|
|
|
|
}
|
2018-02-23 17:57:30 +00:00
|
|
|
if (source != nullptr)
|
|
|
|
{
|
|
|
|
delete source;
|
|
|
|
}
|
2016-03-01 15:47:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer :: IsMIDI
|
|
|
|
//
|
|
|
|
// You bet it is!
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
bool MIDIStreamer::IsMIDI() const
|
|
|
|
{
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer :: IsValid
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
bool MIDIStreamer::IsValid() const
|
|
|
|
{
|
2018-02-23 12:20:07 +00:00
|
|
|
return source != nullptr && source->isValid();
|
2016-03-01 15:47:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer :: SelectMIDIDevice static
|
|
|
|
//
|
|
|
|
// Select the MIDI device to play on
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
EMidiDevice MIDIStreamer::SelectMIDIDevice(EMidiDevice device)
|
|
|
|
{
|
|
|
|
/* MIDI are played as:
|
|
|
|
- OPL:
|
|
|
|
- if explicitly selected by $mididevice
|
|
|
|
- when snd_mididevice is -3 and no midi device is set for the song
|
|
|
|
|
|
|
|
- Timidity:
|
|
|
|
- if explicitly selected by $mididevice
|
|
|
|
- when snd_mididevice is -2 and no midi device is set for the song
|
|
|
|
|
|
|
|
- MMAPI (Win32 only):
|
|
|
|
- if explicitly selected by $mididevice (non-Win32 redirects this to Sound System)
|
|
|
|
- when snd_mididevice is >= 0 and no midi device is set for the song
|
|
|
|
- as fallback when both OPL and Timidity failed and snd_mididevice is >= 0
|
|
|
|
*/
|
|
|
|
|
|
|
|
// Choose the type of MIDI device we want.
|
|
|
|
if (device != MDEV_DEFAULT)
|
|
|
|
{
|
|
|
|
return device;
|
|
|
|
}
|
|
|
|
switch (snd_mididevice)
|
|
|
|
{
|
|
|
|
case -1: return MDEV_SNDSYS;
|
|
|
|
case -2: return MDEV_TIMIDITY;
|
|
|
|
case -3: return MDEV_OPL;
|
|
|
|
case -4: return MDEV_GUS;
|
|
|
|
case -5: return MDEV_FLUIDSYNTH;
|
|
|
|
case -6: return MDEV_WILDMIDI;
|
|
|
|
default:
|
|
|
|
#ifdef _WIN32
|
|
|
|
return MDEV_MMAPI;
|
|
|
|
#else
|
|
|
|
return MDEV_SNDSYS;
|
|
|
|
#endif
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer :: CreateMIDIDevice
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
2017-03-10 18:03:58 +00:00
|
|
|
MIDIDevice *MIDIStreamer::CreateMIDIDevice(EMidiDevice devtype)
|
2016-03-01 15:47:10 +00:00
|
|
|
{
|
2018-02-23 13:36:26 +00:00
|
|
|
// fixme: This should check up front if the device can be started.
|
|
|
|
// Checks to ensure that a device finds a compatible sound font are entirely missing here.
|
|
|
|
|
2016-03-01 15:47:10 +00:00
|
|
|
switch (devtype)
|
|
|
|
{
|
2018-02-23 13:36:26 +00:00
|
|
|
case MDEV_GUS:
|
|
|
|
return new TimidityMIDIDevice(Args);
|
|
|
|
|
2016-03-01 15:47:10 +00:00
|
|
|
case MDEV_MMAPI:
|
|
|
|
#ifdef _WIN32
|
2018-02-23 13:36:26 +00:00
|
|
|
return CreateWinMIDIDevice(mididevice);
|
2016-03-01 15:47:10 +00:00
|
|
|
#endif
|
2018-02-23 13:36:26 +00:00
|
|
|
// Intentional fall-through for non-Windows systems.
|
2017-05-13 10:33:14 +00:00
|
|
|
|
2016-03-01 15:47:10 +00:00
|
|
|
case MDEV_FLUIDSYNTH:
|
|
|
|
case MDEV_SNDSYS:
|
2018-02-23 13:36:26 +00:00
|
|
|
return new FluidSynthMIDIDevice(Args);
|
2016-03-01 15:47:10 +00:00
|
|
|
|
|
|
|
case MDEV_OPL:
|
|
|
|
try
|
|
|
|
{
|
|
|
|
return new OPLMIDIDevice(Args);
|
|
|
|
}
|
|
|
|
catch (CRecoverableError &err)
|
|
|
|
{
|
|
|
|
// The creation of an OPL MIDI device can abort with an error if no GENMIDI lump can be found.
|
2017-05-13 10:33:14 +00:00
|
|
|
Printf("Unable to create OPL MIDI device: %s\nFalling back to default playback", err.GetMessage());
|
|
|
|
return new FluidSynthMIDIDevice(nullptr);
|
2016-03-01 15:47:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
case MDEV_TIMIDITY:
|
2017-03-10 15:12:52 +00:00
|
|
|
return CreateTimidityPPMIDIDevice(Args);
|
2016-03-01 15:47:10 +00:00
|
|
|
|
|
|
|
case MDEV_WILDMIDI:
|
|
|
|
return new WildMIDIDevice(Args);
|
|
|
|
|
|
|
|
default:
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer :: Play
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
void MIDIStreamer::Play(bool looping, int subsong)
|
|
|
|
{
|
|
|
|
EMidiDevice devtype;
|
|
|
|
|
|
|
|
m_Status = STATE_Stopped;
|
|
|
|
m_Looping = looping;
|
|
|
|
EndQueued = 0;
|
|
|
|
VolumeChanged = false;
|
|
|
|
Restarting = true;
|
|
|
|
InitialPlayback = true;
|
2018-02-23 11:40:43 +00:00
|
|
|
if (source == nullptr) return; // We have nothing to play so abort.
|
2016-03-01 15:47:10 +00:00
|
|
|
|
|
|
|
assert(MIDI == NULL);
|
2018-02-23 11:40:43 +00:00
|
|
|
|
|
|
|
// fixme: The device should be attached by the controlling code to allow more flexibility.
|
|
|
|
// It should also separate the softsynth device from the playback engines.
|
|
|
|
// The approach here pretty much prevents the implementation of a generic WAVE writer because no generic dumper device class can be created.
|
2016-03-01 15:47:10 +00:00
|
|
|
devtype = SelectMIDIDevice(DeviceType);
|
2018-02-23 11:40:43 +00:00
|
|
|
|
2016-03-01 15:47:10 +00:00
|
|
|
if (DumpFilename.IsNotEmpty())
|
|
|
|
{
|
|
|
|
if (devtype == MDEV_OPL)
|
|
|
|
{
|
|
|
|
MIDI = new OPLDumperMIDIDevice(DumpFilename);
|
|
|
|
}
|
|
|
|
else if (devtype == MDEV_GUS)
|
|
|
|
{
|
|
|
|
MIDI = new TimidityWaveWriterMIDIDevice(DumpFilename, 0);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
MIDI = CreateMIDIDevice(devtype);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (MIDI == NULL || 0 != MIDI->Open(Callback, this))
|
|
|
|
{
|
|
|
|
Printf(PRINT_BOLD, "Could not open MIDI out device\n");
|
|
|
|
if (MIDI != NULL)
|
|
|
|
{
|
|
|
|
delete MIDI;
|
|
|
|
MIDI = NULL;
|
|
|
|
}
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2018-02-23 11:40:43 +00:00
|
|
|
source->SetMIDISubsong(subsong);
|
|
|
|
source->CheckCaps(MIDI->GetTechnology());
|
2016-03-01 15:47:10 +00:00
|
|
|
|
|
|
|
if (MIDI->Preprocess(this, looping))
|
|
|
|
{
|
|
|
|
StartPlayback();
|
|
|
|
if (MIDI == NULL)
|
|
|
|
{ // The MIDI file had no content and has been automatically closed.
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (0 != MIDI->Resume())
|
|
|
|
{
|
|
|
|
Printf ("Starting MIDI playback failed\n");
|
|
|
|
Stop();
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
2017-03-10 18:03:58 +00:00
|
|
|
m_Status = STATE_Playing;
|
2016-03-01 15:47:10 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer :: StartPlayback
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
void MIDIStreamer::StartPlayback()
|
|
|
|
{
|
2018-02-23 11:40:43 +00:00
|
|
|
auto data = source->PrecacheData();
|
|
|
|
MIDI->PrecacheInstruments(&data[0], data.Size());
|
|
|
|
source->StartPlayback(m_Looping);
|
|
|
|
|
2016-03-01 15:47:10 +00:00
|
|
|
// Set time division and tempo.
|
2018-02-23 11:40:43 +00:00
|
|
|
if (0 != MIDI->SetTimeDiv(source->getDivision()) ||
|
|
|
|
0 != MIDI->SetTempo(source->getInitialTempo()))
|
2016-03-01 15:47:10 +00:00
|
|
|
{
|
|
|
|
Printf(PRINT_BOLD, "Setting MIDI stream speed failed\n");
|
|
|
|
MIDI->Close();
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
MusicVolumeChanged(); // set volume to current music's properties
|
|
|
|
OutputVolume(Volume);
|
|
|
|
|
2017-03-10 18:03:58 +00:00
|
|
|
MIDI->InitPlayback();
|
2016-03-01 15:47:10 +00:00
|
|
|
|
|
|
|
// Fill the initial buffers for the song.
|
|
|
|
BufferNum = 0;
|
|
|
|
do
|
|
|
|
{
|
2018-02-23 11:40:43 +00:00
|
|
|
int res = FillBuffer(BufferNum, MAX_MIDI_EVENTS, MAX_TIME);
|
2016-03-01 15:47:10 +00:00
|
|
|
if (res == SONG_MORE)
|
|
|
|
{
|
|
|
|
if (0 != MIDI->StreamOutSync(&Buffer[BufferNum]))
|
|
|
|
{
|
|
|
|
Printf ("Initial midiStreamOut failed\n");
|
|
|
|
Stop();
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
BufferNum ^= 1;
|
|
|
|
}
|
|
|
|
else if (res == SONG_DONE)
|
|
|
|
{
|
|
|
|
// Do not play super short songs that can't fill the initial two buffers.
|
|
|
|
Stop();
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
Stop();
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
while (BufferNum != 0);
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer :: Pause
|
|
|
|
//
|
|
|
|
// "Pauses" the song by setting it to zero volume and filling subsequent
|
|
|
|
// buffers with NOPs until the song is unpaused. A MIDI device that
|
|
|
|
// supports real pauses will return true from its Pause() method.
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
void MIDIStreamer::Pause()
|
|
|
|
{
|
|
|
|
if (m_Status == STATE_Playing)
|
|
|
|
{
|
|
|
|
m_Status = STATE_Paused;
|
|
|
|
if (!MIDI->Pause(true))
|
|
|
|
{
|
|
|
|
OutputVolume(0);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer :: Resume
|
|
|
|
//
|
|
|
|
// "Unpauses" a song by restoring the volume and letting subsequent
|
|
|
|
// buffers store real MIDI events again.
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
void MIDIStreamer::Resume()
|
|
|
|
{
|
|
|
|
if (m_Status == STATE_Paused)
|
|
|
|
{
|
|
|
|
if (!MIDI->Pause(false))
|
|
|
|
{
|
|
|
|
OutputVolume(Volume);
|
|
|
|
}
|
|
|
|
m_Status = STATE_Playing;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer :: Stop
|
|
|
|
//
|
|
|
|
// Stops playback and closes the player thread and MIDI device.
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
void MIDIStreamer::Stop()
|
|
|
|
{
|
|
|
|
EndQueued = 4;
|
2017-03-10 15:12:52 +00:00
|
|
|
|
2016-03-01 15:47:10 +00:00
|
|
|
if (MIDI != NULL && MIDI->IsOpen())
|
|
|
|
{
|
|
|
|
MIDI->Stop();
|
|
|
|
MIDI->UnprepareHeader(&Buffer[0]);
|
|
|
|
MIDI->UnprepareHeader(&Buffer[1]);
|
|
|
|
MIDI->Close();
|
|
|
|
}
|
|
|
|
if (MIDI != NULL)
|
|
|
|
{
|
|
|
|
delete MIDI;
|
|
|
|
MIDI = NULL;
|
|
|
|
}
|
|
|
|
m_Status = STATE_Stopped;
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer :: IsPlaying
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
bool MIDIStreamer::IsPlaying()
|
|
|
|
{
|
|
|
|
if (m_Status != STATE_Stopped && (MIDI == NULL || (EndQueued != 0 && EndQueued < 4)))
|
|
|
|
{
|
|
|
|
Stop();
|
|
|
|
}
|
|
|
|
if (m_Status != STATE_Stopped && !MIDI->IsOpen())
|
|
|
|
{
|
|
|
|
Stop();
|
|
|
|
}
|
|
|
|
return m_Status != STATE_Stopped;
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer :: MusicVolumeChanged
|
|
|
|
//
|
|
|
|
// WinMM MIDI doesn't go through the sound system, so the normal volume
|
|
|
|
// changing procedure doesn't work for it.
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
void MIDIStreamer::MusicVolumeChanged()
|
|
|
|
{
|
|
|
|
if (MIDI != NULL && MIDI->FakeVolume())
|
|
|
|
{
|
|
|
|
float realvolume = clamp<float>(snd_musicvolume * relative_volume, 0.f, 1.f);
|
2017-03-10 18:46:22 +00:00
|
|
|
Volume = clamp<uint32_t>((uint32_t)(realvolume * 65535.f), 0, 65535);
|
2016-03-01 15:47:10 +00:00
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
Volume = 0xFFFF;
|
|
|
|
}
|
2018-02-23 11:40:43 +00:00
|
|
|
source->setVolume(Volume);
|
2016-03-01 15:47:10 +00:00
|
|
|
if (m_Status == STATE_Playing)
|
|
|
|
{
|
|
|
|
OutputVolume(Volume);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer :: FluidSettingInt
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
void MIDIStreamer::FluidSettingInt(const char *setting, int value)
|
|
|
|
{
|
|
|
|
if (MIDI != NULL)
|
|
|
|
{
|
|
|
|
MIDI->FluidSettingInt(setting, value);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer :: FluidSettingNum
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
void MIDIStreamer::FluidSettingNum(const char *setting, double value)
|
|
|
|
{
|
|
|
|
if (MIDI != NULL)
|
|
|
|
{
|
|
|
|
MIDI->FluidSettingNum(setting, value);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIDeviceStreamer :: FluidSettingStr
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
void MIDIStreamer::FluidSettingStr(const char *setting, const char *value)
|
|
|
|
{
|
|
|
|
if (MIDI != NULL)
|
|
|
|
{
|
|
|
|
MIDI->FluidSettingStr(setting, value);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIDeviceStreamer :: WildMidiSetOption
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
void MIDIStreamer::WildMidiSetOption(int opt, int set)
|
|
|
|
{
|
|
|
|
if (MIDI != NULL)
|
|
|
|
{
|
|
|
|
MIDI->WildMidiSetOption(opt, set);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer :: OutputVolume
|
|
|
|
//
|
|
|
|
// Signals the buffer filler to send volume change events on all channels.
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
2017-03-10 15:12:52 +00:00
|
|
|
void MIDIStreamer::OutputVolume (uint32_t volume)
|
2016-03-01 15:47:10 +00:00
|
|
|
{
|
|
|
|
if (MIDI != NULL && MIDI->FakeVolume())
|
|
|
|
{
|
|
|
|
NewVolume = volume;
|
|
|
|
VolumeChanged = true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer :: Callback Static
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
2017-03-10 11:39:23 +00:00
|
|
|
void MIDIStreamer::Callback(void *userdata)
|
2016-03-01 15:47:10 +00:00
|
|
|
{
|
|
|
|
MIDIStreamer *self = (MIDIStreamer *)userdata;
|
|
|
|
|
|
|
|
if (self->EndQueued >= 4)
|
|
|
|
{
|
|
|
|
return;
|
|
|
|
}
|
2017-03-10 18:03:58 +00:00
|
|
|
self->ServiceEvent();
|
2016-03-01 15:47:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer :: Update
|
|
|
|
//
|
|
|
|
// Called periodically to see if the player thread is still alive. If it
|
|
|
|
// isn't, stop playback now.
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
void MIDIStreamer::Update()
|
|
|
|
{
|
2017-03-12 23:38:59 +00:00
|
|
|
if (MIDI != nullptr && !MIDI->Update()) Stop();
|
2016-03-01 15:47:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer :: ServiceEvent
|
|
|
|
//
|
|
|
|
// Fills the buffer that just finished playing with new events and appends
|
|
|
|
// it to the MIDI stream queue. Stops the song if playback is over. Returns
|
|
|
|
// non-zero if a problem occured and playback should stop.
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
int MIDIStreamer::ServiceEvent()
|
|
|
|
{
|
|
|
|
int res;
|
|
|
|
|
|
|
|
if (EndQueued == 2)
|
|
|
|
{
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
if (0 != (res = MIDI->UnprepareHeader(&Buffer[BufferNum])))
|
|
|
|
{
|
|
|
|
return res;
|
|
|
|
}
|
|
|
|
fill:
|
|
|
|
if (EndQueued == 1)
|
|
|
|
{
|
|
|
|
res = FillStopBuffer(BufferNum);
|
|
|
|
if ((res & 3) != SONG_ERROR)
|
|
|
|
{
|
|
|
|
EndQueued = 2;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
2018-02-23 11:40:43 +00:00
|
|
|
res = FillBuffer(BufferNum, MAX_MIDI_EVENTS, MAX_TIME);
|
2016-03-01 15:47:10 +00:00
|
|
|
}
|
|
|
|
switch (res & 3)
|
|
|
|
{
|
|
|
|
case SONG_MORE:
|
2017-03-10 18:03:58 +00:00
|
|
|
res = MIDI->StreamOut(&Buffer[BufferNum]);
|
|
|
|
if (res != 0)
|
2016-03-01 15:47:10 +00:00
|
|
|
{
|
|
|
|
return res;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
BufferNum ^= 1;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case SONG_DONE:
|
|
|
|
if (m_Looping)
|
|
|
|
{
|
|
|
|
Restarting = true;
|
|
|
|
goto fill;
|
|
|
|
}
|
|
|
|
EndQueued = 1;
|
|
|
|
break;
|
|
|
|
|
|
|
|
default:
|
|
|
|
return res >> 2;
|
|
|
|
}
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer :: FillBuffer
|
|
|
|
//
|
|
|
|
// Copies MIDI events from the MIDI file and puts them into a MIDI stream
|
|
|
|
// buffer. Filling the buffer stops when the song end is encountered, the
|
|
|
|
// buffer space is used up, or the maximum time for a buffer is hit.
|
|
|
|
//
|
|
|
|
// Can return:
|
|
|
|
// - SONG_MORE if the buffer was prepared with data.
|
|
|
|
// - SONG_DONE if the song's end was reached.
|
|
|
|
// The buffer will never have data in this case.
|
|
|
|
// - SONG_ERROR if there was a problem preparing the buffer.
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
2017-03-10 15:12:52 +00:00
|
|
|
int MIDIStreamer::FillBuffer(int buffer_num, int max_events, uint32_t max_time)
|
2016-03-01 15:47:10 +00:00
|
|
|
{
|
2018-02-23 11:40:43 +00:00
|
|
|
if (!Restarting && source->CheckDone())
|
2016-03-01 15:47:10 +00:00
|
|
|
{
|
|
|
|
return SONG_DONE;
|
|
|
|
}
|
|
|
|
|
|
|
|
int i;
|
2017-03-10 15:12:52 +00:00
|
|
|
uint32_t *events = Events[buffer_num], *max_event_p;
|
|
|
|
uint32_t tot_time = 0;
|
|
|
|
uint32_t time = 0;
|
2016-03-01 15:47:10 +00:00
|
|
|
|
|
|
|
// The final event is for a NOP to hold the delay from the last event.
|
|
|
|
max_event_p = events + (max_events - 1) * 3;
|
|
|
|
|
|
|
|
if (InitialPlayback)
|
|
|
|
{
|
|
|
|
InitialPlayback = false;
|
|
|
|
// Send the full master volume SysEx message.
|
|
|
|
events[0] = 0; // dwDeltaTime
|
|
|
|
events[1] = 0; // dwStreamID
|
2017-03-10 11:39:23 +00:00
|
|
|
events[2] = (MEVENT_LONGMSG << 24) | 8; // dwEvent
|
2016-03-01 15:47:10 +00:00
|
|
|
events[3] = MAKE_ID(0xf0,0x7f,0x7f,0x04); // dwParms[0]
|
|
|
|
events[4] = MAKE_ID(0x01,0x7f,0x7f,0xf7); // dwParms[1]
|
|
|
|
events += 5;
|
2018-02-23 11:40:43 +00:00
|
|
|
source->DoInitialSetup();
|
2016-03-01 15:47:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// If the volume has changed, stick those events at the start of this buffer.
|
|
|
|
if (VolumeChanged && (m_Status != STATE_Paused || NewVolume == 0))
|
|
|
|
{
|
|
|
|
VolumeChanged = false;
|
|
|
|
for (i = 0; i < 16; ++i)
|
|
|
|
{
|
2018-02-23 11:40:43 +00:00
|
|
|
uint8_t courseVol = (uint8_t)(((source->getChannelVolume(i)+1) * NewVolume) >> 16);
|
2016-03-01 15:47:10 +00:00
|
|
|
events[0] = 0; // dwDeltaTime
|
|
|
|
events[1] = 0; // dwStreamID
|
|
|
|
events[2] = MIDI_CTRLCHANGE | i | (7<<8) | (courseVol<<16);
|
|
|
|
events += 3;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Play nothing while paused.
|
|
|
|
if (m_Status == STATE_Paused)
|
|
|
|
{
|
|
|
|
// Be more responsive when unpausing by only playing each buffer
|
|
|
|
// for a third of the maximum time.
|
2018-02-23 11:40:43 +00:00
|
|
|
events[0] = MAX<uint32_t>(1, (max_time / 3) * source->getDivision() / source->getTempo());
|
2016-03-01 15:47:10 +00:00
|
|
|
events[1] = 0;
|
2017-03-10 11:39:23 +00:00
|
|
|
events[2] = MEVENT_NOP << 24;
|
2016-03-01 15:47:10 +00:00
|
|
|
events += 3;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
if (Restarting)
|
|
|
|
{
|
|
|
|
Restarting = false;
|
|
|
|
// Reset the tempo to the inital value.
|
|
|
|
events[0] = 0; // dwDeltaTime
|
|
|
|
events[1] = 0; // dwStreamID
|
2018-02-23 11:40:43 +00:00
|
|
|
events[2] = (MEVENT_TEMPO << 24) | source->getInitialTempo(); // dwEvent
|
2016-03-01 15:47:10 +00:00
|
|
|
events += 3;
|
|
|
|
// Stop all notes in case any were left hanging.
|
|
|
|
events = WriteStopNotes(events);
|
2018-02-23 11:40:43 +00:00
|
|
|
source->DoRestart();
|
2016-03-01 15:47:10 +00:00
|
|
|
}
|
2018-02-23 11:40:43 +00:00
|
|
|
events = source->MakeEvents(events, max_event_p, max_time);
|
2016-03-01 15:47:10 +00:00
|
|
|
}
|
2017-03-10 11:01:29 +00:00
|
|
|
memset(&Buffer[buffer_num], 0, sizeof(MidiHeader));
|
|
|
|
Buffer[buffer_num].lpData = (uint8_t *)Events[buffer_num];
|
|
|
|
Buffer[buffer_num].dwBufferLength = uint32_t((uint8_t *)events - Buffer[buffer_num].lpData);
|
2016-03-01 15:47:10 +00:00
|
|
|
Buffer[buffer_num].dwBytesRecorded = Buffer[buffer_num].dwBufferLength;
|
|
|
|
if (0 != (i = MIDI->PrepareHeader(&Buffer[buffer_num])))
|
|
|
|
{
|
|
|
|
return SONG_ERROR | (i << 2);
|
|
|
|
}
|
|
|
|
return SONG_MORE;
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer :: FillStopBuffer
|
|
|
|
//
|
|
|
|
// Fills a MIDI buffer with events to stop all channels.
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
int MIDIStreamer::FillStopBuffer(int buffer_num)
|
|
|
|
{
|
2017-03-10 15:12:52 +00:00
|
|
|
uint32_t *events = Events[buffer_num];
|
2016-03-01 15:47:10 +00:00
|
|
|
int i;
|
|
|
|
|
|
|
|
events = WriteStopNotes(events);
|
|
|
|
|
|
|
|
// wait some tics, just so that this buffer takes some time
|
|
|
|
events[0] = 500;
|
|
|
|
events[1] = 0;
|
2017-03-10 11:39:23 +00:00
|
|
|
events[2] = MEVENT_NOP << 24;
|
2016-03-01 15:47:10 +00:00
|
|
|
events += 3;
|
|
|
|
|
2017-03-10 11:01:29 +00:00
|
|
|
memset(&Buffer[buffer_num], 0, sizeof(MidiHeader));
|
|
|
|
Buffer[buffer_num].lpData = (uint8_t*)Events[buffer_num];
|
2017-03-10 18:46:22 +00:00
|
|
|
Buffer[buffer_num].dwBufferLength = uint32_t((uint8_t*)events - Buffer[buffer_num].lpData);
|
2016-03-01 15:47:10 +00:00
|
|
|
Buffer[buffer_num].dwBytesRecorded = Buffer[buffer_num].dwBufferLength;
|
|
|
|
if (0 != (i = MIDI->PrepareHeader(&Buffer[buffer_num])))
|
|
|
|
{
|
|
|
|
return SONG_ERROR | (i << 2);
|
|
|
|
}
|
|
|
|
return SONG_MORE;
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer :: WriteStopNotes
|
|
|
|
//
|
|
|
|
// Generates MIDI events to stop all notes and reset controllers on
|
|
|
|
// every channel.
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
2017-03-10 15:12:52 +00:00
|
|
|
uint32_t *MIDIStreamer::WriteStopNotes(uint32_t *events)
|
2016-03-01 15:47:10 +00:00
|
|
|
{
|
|
|
|
for (int i = 0; i < 16; ++i)
|
|
|
|
{
|
|
|
|
events[0] = 0; // dwDeltaTime
|
|
|
|
events[1] = 0; // dwStreamID
|
|
|
|
events[2] = MIDI_CTRLCHANGE | i | (123 << 8); // All notes off
|
|
|
|
events[3] = 0;
|
|
|
|
events[4] = 0;
|
|
|
|
events[5] = MIDI_CTRLCHANGE | i | (121 << 8); // Reset controllers
|
|
|
|
events += 6;
|
|
|
|
}
|
|
|
|
return events;
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
//
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
2018-02-23 11:40:43 +00:00
|
|
|
void MIDIStreamer::SetMIDISource(MIDISource *_source)
|
2016-03-01 15:47:10 +00:00
|
|
|
{
|
2018-02-23 11:40:43 +00:00
|
|
|
source = _source;
|
|
|
|
source->setTempoCallback([=](int tempo) { return MIDI->SetTempo(tempo); } );
|
2016-03-01 15:47:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer :: GetStats
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
FString MIDIStreamer::GetStats()
|
|
|
|
{
|
|
|
|
if (MIDI == NULL)
|
|
|
|
{
|
|
|
|
return "No MIDI device in use.";
|
|
|
|
}
|
|
|
|
return MIDI->GetStats();
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIStreamer :: SetSubsong
|
|
|
|
//
|
|
|
|
// Selects which subsong to play in an already-playing file. This is public.
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
bool MIDIStreamer::SetSubsong(int subsong)
|
|
|
|
{
|
2018-02-23 11:40:43 +00:00
|
|
|
if (source->SetMIDISubsong(subsong))
|
2016-03-01 15:47:10 +00:00
|
|
|
{
|
|
|
|
Stop();
|
|
|
|
Play(m_Looping, subsong);
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIDevice stubs.
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
MIDIDevice::MIDIDevice()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
MIDIDevice::~MIDIDevice()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIDevice :: PrecacheInstruments
|
|
|
|
//
|
|
|
|
// The MIDIStreamer calls this method between device open and the first
|
|
|
|
// buffered stream with a list of instruments known to be used by the song.
|
|
|
|
// If the device can benefit from preloading the instruments, it can do so
|
|
|
|
// now.
|
|
|
|
//
|
|
|
|
// Each entry is packed as follows:
|
|
|
|
// Bits 0- 6: Instrument number
|
|
|
|
// Bits 7-13: Bank number
|
|
|
|
// Bit 14: Select drum set if 1, tone bank if 0
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
2017-03-08 17:50:37 +00:00
|
|
|
void MIDIDevice::PrecacheInstruments(const uint16_t *instruments, int count)
|
2016-03-01 15:47:10 +00:00
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIDevice :: Preprocess
|
|
|
|
//
|
|
|
|
// Gives the MIDI device a chance to do some processing with the song before
|
|
|
|
// it starts playing it. Returns true if MIDIStreamer should perform its
|
|
|
|
// standard playback startup sequence.
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
bool MIDIDevice::Preprocess(MIDIStreamer *song, bool looping)
|
|
|
|
{
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIDevice :: PrepareHeader
|
|
|
|
//
|
|
|
|
// Wrapper for MCI's midiOutPrepareHeader.
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
2017-03-10 11:01:29 +00:00
|
|
|
int MIDIDevice::PrepareHeader(MidiHeader *header)
|
2016-03-01 15:47:10 +00:00
|
|
|
{
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIDevice :: UnprepareHeader
|
|
|
|
//
|
|
|
|
// Wrapper for MCI's midiOutUnprepareHeader.
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
2017-03-10 11:01:29 +00:00
|
|
|
int MIDIDevice::UnprepareHeader(MidiHeader *header)
|
2016-03-01 15:47:10 +00:00
|
|
|
{
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIDevice :: FakeVolume
|
|
|
|
//
|
|
|
|
// Since most implementations render as a normal stream, their volume is
|
|
|
|
// controlled through the GSnd interface, not here.
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
bool MIDIDevice::FakeVolume()
|
|
|
|
{
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
//
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
2017-03-10 18:03:58 +00:00
|
|
|
void MIDIDevice::InitPlayback()
|
2016-03-01 15:47:10 +00:00
|
|
|
{
|
2017-03-10 18:03:58 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
//
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
bool MIDIDevice::Update()
|
|
|
|
{
|
|
|
|
return true;
|
2016-03-01 15:47:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIDevice :: FluidSettingInt
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
void MIDIDevice::FluidSettingInt(const char *setting, int value)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIDevice :: FluidSettingNum
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
void MIDIDevice::FluidSettingNum(const char *setting, double value)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIDevice :: FluidSettingStr
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
void MIDIDevice::FluidSettingStr(const char *setting, const char *value)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIDevice :: WildMidiSetOption
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
void MIDIDevice::WildMidiSetOption(int opt, int set)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
//==========================================================================
|
|
|
|
//
|
|
|
|
// MIDIDevice :: GetStats
|
|
|
|
//
|
|
|
|
//==========================================================================
|
|
|
|
|
|
|
|
FString MIDIDevice::GetStats()
|
|
|
|
{
|
|
|
|
return "This MIDI device does not have any stats.";
|
|
|
|
}
|