11 #include "../stdafx.h"
12 #ifdef WIN32_LEAN_AND_MEAN
13 # undef WIN32_LEAN_AND_MEAN
16 #include "../os/windows/win32.h"
17 #include "../core/mem_func.hpp"
18 #include "../thread.h"
19 #include "../fileio_func.h"
20 #include "../base_media_base.h"
22 #include "midifile.hpp"
30 #include "../safeguards.h"
33 # pragma comment(lib, "ole32.lib")
40 #define FOURCC_INFO mmioFOURCC('I', 'N', 'F', 'O')
41 #define FOURCC_fmt mmioFOURCC('f', 'm', 't', ' ')
42 #define FOURCC_data mmioFOURCC('d', 'a', 't', 'a')
52 std::vector<WLOOP> wave_loops;
53 std::vector<CONNECTION> articulators;
60 std::vector<CONNECTION> articulators;
61 std::vector<DLSRegion> regions;
69 std::vector<BYTE> data;
72 std::vector<WLOOP> wave_loops;
74 bool operator ==(
long offset)
const
76 return this->file_offset == offset;
80 std::vector<DLSInstrument> instruments;
81 std::vector<POOLCUE> pool_cues;
82 std::vector<DLSWave> waves;
85 bool LoadFile(
const std::string &file);
112 DMUS_DOWNLOADINFO dlInfo;
113 ULONG ulOffsetTable[2];
115 DMUS_WAVEDATA dmWaveData;
147 static IDirectMusicPort *
_port =
nullptr;
159 while (list_length > 0) {
161 if (fread(&chunk,
sizeof(chunk), 1, f) != 1)
return false;
162 list_length -= chunk.length +
sizeof(chunk);
164 if (chunk.type == FOURCC_ART1) {
165 CONNECTIONLIST conns;
166 if (fread(&conns,
sizeof(conns), 1, f) != 1)
return false;
167 fseek(f, conns.cbSize -
sizeof(conns), SEEK_CUR);
170 for (ULONG i = 0; i < conns.cConnections; i++) {
172 if (fread(&con,
sizeof(con), 1, f) != 1)
return false;
176 fseek(f, chunk.length, SEEK_CUR);
188 region.wave_sample.cbSize = 0;
190 while (list_length > 0) {
192 if (fread(&chunk,
sizeof(chunk), 1, f) != 1)
return false;
193 list_length -= chunk.length +
sizeof(chunk);
195 if (chunk.type == FOURCC_LIST) {
197 if (fread(&chunk.type,
sizeof(chunk.type), 1, f) != 1)
return false;
198 chunk.length -=
sizeof(chunk.type);
201 switch (chunk.type) {
203 if (fread(®ion.hdr,
sizeof(region.hdr), 1, f) != 1)
return false;
207 if (fread(®ion.wave_sample,
sizeof(region.wave_sample), 1, f) != 1)
return false;
208 fseek(f, region.wave_sample.cbSize -
sizeof(region.wave_sample), SEEK_CUR);
211 for (ULONG i = 0; i < region.wave_sample.cSampleLoops; i++) {
213 if (fread(&loop,
sizeof(loop), 1, f) != 1)
return false;
214 region.wave_loops.push_back(loop);
219 if (fread(®ion.wave,
sizeof(region.wave), 1, f) != 1)
return false;
228 fseek(f, chunk.length, SEEK_CUR);
232 Debug(driver, 7,
"DLS: Ignoring unknown chunk {}{}{}{}", (
char)(chunk.type & 0xFF), (
char)((chunk.type >> 8) & 0xFF), (
char)((chunk.type >> 16) & 0xFF), (
char)((chunk.type >> 24) & 0xFF));
233 fseek(f, chunk.length, SEEK_CUR);
243 while (list_length > 0) {
245 if (fread(&chunk,
sizeof(chunk), 1, f) != 1)
return false;
246 list_length -= chunk.length +
sizeof(chunk);
248 if (chunk.type == FOURCC_LIST) {
250 if (fread(&list_type,
sizeof(list_type), 1, f) != 1)
return false;
252 if (list_type == FOURCC_RGN) {
253 this->
ReadDLSRegion(f, chunk.length -
sizeof(list_type), instrument.regions);
255 Debug(driver, 7,
"DLS: Ignoring unknown list chunk of type {}{}{}{}", (
char)(list_type & 0xFF), (
char)((list_type >> 8) & 0xFF), (
char)((list_type >> 16) & 0xFF), (
char)((list_type >> 24) & 0xFF));
256 fseek(f, chunk.length -
sizeof(list_type), SEEK_CUR);
259 Debug(driver, 7,
"DLS: Ignoring chunk {}{}{}{}", (
char)(chunk.type & 0xFF), (
char)((chunk.type >> 8) & 0xFF), (
char)((chunk.type >> 16) & 0xFF), (
char)((chunk.type >> 24) & 0xFF));
260 fseek(f, chunk.length, SEEK_CUR);
269 DLSInstrument &instrument = this->instruments.emplace_back();
271 while (list_length > 0) {
273 if (fread(&chunk,
sizeof(chunk), 1, f) != 1)
return false;
274 list_length -= chunk.length +
sizeof(chunk);
276 if (chunk.type == FOURCC_LIST) {
278 if (fread(&chunk.type,
sizeof(chunk.type), 1, f) != 1)
return false;
279 chunk.length -=
sizeof(chunk.type);
282 switch (chunk.type) {
284 if (fread(&instrument.hdr,
sizeof(instrument.hdr), 1, f) != 1)
return false;
297 fseek(f, chunk.length, SEEK_CUR);
301 Debug(driver, 7,
"DLS: Ignoring unknown chunk {}{}{}{}", (
char)(chunk.type & 0xFF), (
char)((chunk.type >> 8) & 0xFF), (
char)((chunk.type >> 16) & 0xFF), (
char)((chunk.type >> 24) & 0xFF));
302 fseek(f, chunk.length, SEEK_CUR);
312 while (list_length > 0) {
314 if (fread(&chunk,
sizeof(chunk), 1, f) != 1)
return false;
315 list_length -= chunk.length +
sizeof(chunk);
317 if (chunk.type == FOURCC_LIST) {
319 if (fread(&list_type,
sizeof(list_type), 1, f) != 1)
return false;
321 if (list_type == FOURCC_INS) {
322 Debug(driver, 6,
"DLS: Reading instrument {}", (
int)instruments.size());
326 Debug(driver, 7,
"DLS: Ignoring unknown list chunk of type {}{}{}{}", (
char)(list_type & 0xFF), (
char)((list_type >> 8) & 0xFF), (
char)((list_type >> 16) & 0xFF), (
char)((list_type >> 24) & 0xFF));
327 fseek(f, chunk.length -
sizeof(list_type), SEEK_CUR);
330 Debug(driver, 7,
"DLS: Ignoring chunk {}{}{}{}", (
char)(chunk.type & 0xFF), (
char)((chunk.type >> 8) & 0xFF), (
char)((chunk.type >> 16) & 0xFF), (
char)((chunk.type >> 24) & 0xFF));
331 fseek(f, chunk.length, SEEK_CUR);
340 DLSWave &wave = this->waves.emplace_back();
344 wave.wave_sample.cbSize =
sizeof(WSMPL);
345 wave.wave_sample.usUnityNote = 60;
346 wave.file_offset = offset;
348 while (list_length > 0) {
350 if (fread(&chunk,
sizeof(chunk), 1, f) != 1)
return false;
351 list_length -= chunk.length +
sizeof(chunk);
353 if (chunk.type == FOURCC_LIST) {
355 if (fread(&chunk.type,
sizeof(chunk.type), 1, f) != 1)
return false;
356 chunk.length -=
sizeof(chunk.type);
359 switch (chunk.type) {
361 if (fread(&wave.fmt,
sizeof(wave.fmt), 1, f) != 1)
return false;
362 if (chunk.length >
sizeof(wave.fmt)) fseek(f, chunk.length -
sizeof(wave.fmt), SEEK_CUR);
366 if (fread(&wave.wave_sample,
sizeof(wave.wave_sample), 1, f) != 1)
return false;
367 fseek(f, wave.wave_sample.cbSize -
sizeof(wave.wave_sample), SEEK_CUR);
370 for (ULONG i = 0; i < wave.wave_sample.cSampleLoops; i++) {
372 if (fread(&loop,
sizeof(loop), 1, f) != 1)
return false;
373 wave.wave_loops.push_back(loop);
378 wave.data.resize(chunk.length);
379 if (fread(&wave.data[0],
sizeof(BYTE), wave.data.size(), f) != wave.data.size())
return false;
384 fseek(f, chunk.length, SEEK_CUR);
388 Debug(driver, 7,
"DLS: Ignoring unknown chunk {}{}{}{}", (
char)(chunk.type & 0xFF), (
char)((chunk.type >> 8) & 0xFF), (
char)((chunk.type >> 16) & 0xFF), (
char)((chunk.type >> 24) & 0xFF));
389 fseek(f, chunk.length, SEEK_CUR);
399 long base_offset = ftell(f);
401 while (list_length > 0) {
402 long chunk_offset = ftell(f);
405 if (fread(&chunk,
sizeof(chunk), 1, f) != 1)
return false;
406 list_length -= chunk.length +
sizeof(chunk);
408 if (chunk.type == FOURCC_LIST) {
410 if (fread(&list_type,
sizeof(list_type), 1, f) != 1)
return false;
412 if (list_type == FOURCC_wave) {
413 Debug(driver, 6,
"DLS: Reading wave {}", waves.size());
415 if (!this->
ReadDLSWave(f, chunk.length -
sizeof(list_type), chunk_offset - base_offset))
return false;
417 Debug(driver, 7,
"DLS: Ignoring unknown list chunk of type {}{}{}{}", (
char)(list_type & 0xFF), (
char)((list_type >> 8) & 0xFF), (
char)((list_type >> 16) & 0xFF), (
char)((list_type >> 24) & 0xFF));
418 fseek(f, chunk.length -
sizeof(list_type), SEEK_CUR);
421 Debug(driver, 7,
"DLS: Ignoring chunk {}{}{}{}", (
char)(chunk.type & 0xFF), (
char)((chunk.type >> 8) & 0xFF), (
char)((chunk.type >> 16) & 0xFF), (
char)((chunk.type >> 24) & 0xFF));
422 fseek(f, chunk.length, SEEK_CUR);
431 Debug(driver, 2,
"DMusic: Try to load DLS file {}", file);
434 if (!of.has_value())
return false;
440 if (fread(&hdr,
sizeof(hdr), 1, f) != 1)
return false;
441 if (fread(&dls_type,
sizeof(dls_type), 1, f) != 1)
return false;
442 if (hdr.type != FOURCC_RIFF || dls_type != FOURCC_DLS)
return false;
444 hdr.length -=
sizeof(FOURCC);
446 Debug(driver, 2,
"DMusic: Parsing DLS file");
452 while (hdr.length > 0) {
454 if (fread(&chunk,
sizeof(chunk), 1, f) != 1)
return false;
455 hdr.length -= chunk.length +
sizeof(chunk);
457 if (chunk.type == FOURCC_LIST) {
459 if (fread(&chunk.type,
sizeof(chunk.type), 1, f) != 1)
return false;
460 chunk.length -=
sizeof(chunk.type);
463 switch (chunk.type) {
465 if (fread(&header,
sizeof(header), 1, f) != 1)
return false;
478 if (fread(&ptbl,
sizeof(ptbl), 1, f) != 1)
return false;
479 fseek(f, ptbl.cbSize -
sizeof(ptbl), SEEK_CUR);
482 for (ULONG i = 0; i < ptbl.cCues; i++) {
484 if (fread(&cue,
sizeof(cue), 1, f) != 1)
return false;
485 this->pool_cues.push_back(cue);
491 fseek(f, chunk.length, SEEK_CUR);
495 Debug(driver, 7,
"DLS: Ignoring unknown chunk {}{}{}{}", (
char)(chunk.type & 0xFF), (
char)((chunk.type >> 8) & 0xFF), (
char)((chunk.type >> 16) & 0xFF), (
char)((chunk.type >> 24) & 0xFF));
496 fseek(f, chunk.length, SEEK_CUR);
502 if (header.cInstruments != this->instruments.size())
return false;
505 for (std::vector<POOLCUE>::iterator cue = this->pool_cues.begin(); cue != this->pool_cues.end(); cue++) {
506 std::vector<DLSWave>::iterator w = std::find(this->waves.begin(), this->waves.end(), cue->ulOffset);
507 if (w != this->waves.end()) {
508 cue->ulOffset = (ULONG)(w - this->waves.begin());
518 static uint8_t ScaleVolume(uint8_t original, uint8_t scale)
520 return original * scale / 127;
523 static void TransmitChannelMsg(IDirectMusicBuffer *buffer, REFERENCE_TIME rt, uint8_t status, uint8_t p1, uint8_t p2 = 0)
525 if (buffer->PackStructured(rt, 0, status | (p1 << 8) | (p2 << 16)) == E_OUTOFMEMORY) {
527 _port->PlayBuffer(buffer);
530 buffer->PackStructured(rt, 0, status | (p1 << 8) | (p2 << 16));
534 static void TransmitSysex(IDirectMusicBuffer *buffer, REFERENCE_TIME rt,
const uint8_t *&msg_start,
size_t &remaining)
537 const uint8_t *msg_end = msg_start;
538 while (*msg_end != MIDIST_ENDSYSEX) msg_end++;
541 if (buffer->PackUnstructured(rt, 0, msg_end - msg_start,
const_cast<LPBYTE
>(msg_start)) == E_OUTOFMEMORY) {
543 _port->PlayBuffer(buffer);
546 buffer->PackUnstructured(rt, 0, msg_end - msg_start,
const_cast<LPBYTE
>(msg_start));
550 remaining -= msg_end - msg_start;
554 static void TransmitStandardSysex(IDirectMusicBuffer *buffer, REFERENCE_TIME rt, MidiSysexMessage msg)
557 const uint8_t *data = MidiGetStandardSysexMessage(msg, length);
558 TransmitSysex(buffer, rt, data, length);
562 static void TransmitNotesOff(IDirectMusicBuffer *buffer, REFERENCE_TIME block_time, REFERENCE_TIME cur_time)
564 for (
int ch = 0; ch < 16; ch++) {
565 TransmitChannelMsg(buffer, block_time + 10, MIDIST_CONTROLLER | ch, MIDICT_MODE_ALLNOTESOFF, 0);
566 TransmitChannelMsg(buffer, block_time + 10, MIDIST_CONTROLLER | ch, MIDICT_SUSTAINSW, 0);
567 TransmitChannelMsg(buffer, block_time + 10, MIDIST_CONTROLLER | ch, MIDICT_MODE_RESETALLCTRL, 0);
571 TransmitStandardSysex(buffer, block_time + 20, MidiSysexMessage::ResetGM);
572 TransmitStandardSysex(buffer, block_time + 30, MidiSysexMessage::RolandSetReverb);
576 _port->PlayBuffer(buffer);
583 static void MidiThreadProc()
585 Debug(driver, 2,
"DMusic: Entering playback thread");
587 REFERENCE_TIME last_volume_time = 0;
588 REFERENCE_TIME block_time = 0;
597 IReferenceClock *clock;
598 _port->GetLatencyClock(&clock);
600 REFERENCE_TIME cur_time;
601 clock->GetTime(&cur_time);
606 DWORD next_timeout = 1000;
609 DWORD wfso = WaitForSingleObject(
_thread_event, next_timeout);
611 if (_playback.shutdown) {
612 _playback.playing =
false;
616 if (_playback.do_stop) {
617 Debug(driver, 2,
"DMusic thread: Stopping playback");
620 clock->GetTime(&cur_time);
623 _playback.playing =
false;
624 _playback.do_stop =
false;
630 if (wfso == WAIT_OBJECT_0) {
631 if (_playback.do_start) {
632 Debug(driver, 2,
"DMusic thread: Starting playback");
641 _playback.playing =
true;
642 _playback.do_start =
false;
646 clock->GetTime(&cur_time);
652 last_volume_time = 0;
660 if (_playback.playing) {
666 size_t preload_bytes = 0;
669 preload_bytes += block.
data.size();
672 Debug(driver, 2,
"DMusic: timer: loop from block {} (ticktime {}, realtime {:.3f}, bytes {})", bl, block.
ticktime, ((
int)block.
realtime) / 1000.0, preload_bytes);
679 Debug(driver, 2,
"DMusic: timer: start from block {} (ticktime {}, realtime {:.3f}, bytes {})", bl, block.
ticktime, ((
int)block.
realtime) / 1000.0, preload_bytes);
688 REFERENCE_TIME current_time;
689 clock->GetTime(¤t_time);
694 Debug(driver, 2,
"DMusic thread: volume change");
696 last_volume_time = current_time;
697 for (
int ch = 0; ch < 16; ch++) {
699 TransmitChannelMsg(
_buffer, block_time + 1, MIDIST_CONTROLLER | ch, MIDICT_CHANVOLUME, vol);
712 Debug(driver, 2,
"DMusic thread: Looping song");
716 _playback.do_stop =
true;
734 const uint8_t *data = block.
data.data();
735 size_t remaining = block.
data.size();
736 uint8_t last_status = 0;
737 while (remaining > 0) {
740 uint8_t status = data[0];
742 last_status = status;
746 status = last_status;
748 switch (status & 0xF0) {
750 case MIDIST_CHANPRESS:
752 TransmitChannelMsg(
_buffer, block_time, status, data[0]);
758 case MIDIST_POLYPRESS:
759 case MIDIST_PITCHBEND:
761 TransmitChannelMsg(
_buffer, block_time, status, data[0], data[1]);
765 case MIDIST_CONTROLLER:
767 if (data[0] == MIDICT_CHANVOLUME) {
771 TransmitChannelMsg(
_buffer, block_time, status, data[0], vol);
774 TransmitChannelMsg(
_buffer, block_time, status, data[0], data[1]);
783 TransmitSysex(
_buffer, block_time, data, remaining);
785 case MIDIST_TC_QFRAME:
790 case MIDIST_SONGPOSPTR:
805 DWORD used_buffer = 0;
806 _buffer->GetUsedBytes(&used_buffer);
807 if (used_buffer > 0) {
818 _playback.do_stop =
true;
825 Debug(driver, 2,
"DMusic: Exiting playback thread");
828 clock->GetTime(&cur_time);
830 Sleep(_playback.preload_time * 4);
835 static void * DownloadArticulationData(
int base_offset,
void *data,
const std::vector<CONNECTION> &artic)
837 DMUS_ARTICULATION2 *art = (DMUS_ARTICULATION2 *)data;
838 art->ulArtIdx = base_offset + 1;
839 art->ulFirstExtCkIdx = 0;
840 art->ulNextArtIdx = 0;
842 CONNECTIONLIST *con_list = (CONNECTIONLIST *)(art + 1);
843 con_list->cbSize =
sizeof(CONNECTIONLIST);
844 con_list->cConnections = (ULONG)artic.size();
845 MemCpyT((CONNECTION *)(con_list + 1), &artic.front(), artic.size());
847 return (CONNECTION *)(con_list + 1) + artic.size();
850 static const char *LoadDefaultDLSFile(
const char *user_dls)
854 caps.dwSize =
sizeof(DMUS_PORTCAPS);
855 _port->GetCaps(&caps);
858 if ((caps.dwFlags & (DMUS_PC_DLS | DMUS_PC_DLS2)) != 0 && (caps.dwFlags & DMUS_PC_GMINHARDWARE) == 0) {
861 if (user_dls ==
nullptr) {
864 if (SUCCEEDED(RegOpenKeyEx(HKEY_LOCAL_MACHINE, L
"Software\\Microsoft\\DirectMusic", 0, KEY_READ, &hkDM))) {
865 wchar_t dls_path[MAX_PATH];
866 DWORD buf_size =
sizeof(dls_path);
867 if (SUCCEEDED(RegQueryValueEx(hkDM, L
"GMFilePath",
nullptr,
nullptr, (LPBYTE)dls_path, &buf_size))) {
868 wchar_t expand_path[MAX_PATH * 2];
869 ExpandEnvironmentStrings(dls_path, expand_path,
static_cast<DWORD
>(std::size(expand_path)));
870 if (!dls_file.
LoadFile(
FS2OTTD(expand_path)))
Debug(driver, 1,
"Failed to load default GM DLS file from registry");
876 if (dls_file.instruments.empty()) {
877 static const wchar_t *DLS_GM_FILE = L
"%windir%\\System32\\drivers\\gm.dls";
878 wchar_t path[MAX_PATH];
879 ExpandEnvironmentStrings(DLS_GM_FILE, path,
static_cast<DWORD
>(std::size(path)));
881 if (!dls_file.
LoadFile(
FS2OTTD(path)))
return "Can't load GM DLS collection";
884 if (!dls_file.
LoadFile(user_dls))
return "Can't load GM DLS collection";
888 IDirectMusicPortDownload *download_port =
nullptr;
889 if (FAILED(
_port->QueryInterface(IID_IDirectMusicPortDownload, (LPVOID *)&download_port)))
return "Can't get download port";
891 DWORD dlid_wave = 0, dlid_inst = 0;
892 if (FAILED(download_port->GetDLId(&dlid_wave, (DWORD)dls_file.waves.size())) || FAILED(download_port->GetDLId(&dlid_inst, (DWORD)dls_file.instruments.size()))) {
893 download_port->Release();
894 return "Can't get enough DLS ids";
898 download_port->GetAppend(&dwAppend);
901 for (DWORD i = 0; i < dls_file.waves.size(); i++) {
902 IDirectMusicDownload *dl_wave =
nullptr;
903 if (FAILED(download_port->AllocateBuffer((DWORD)(
sizeof(WAVE_DOWNLOAD) + dwAppend * dls_file.waves[i].fmt.wf.nBlockAlign + dls_file.waves[i].data.size()), &dl_wave))) {
904 download_port->Release();
905 return "Can't allocate wave download buffer";
910 if (FAILED(dl_wave->GetBuffer((LPVOID *)&wave, &wave_size))) {
912 download_port->Release();
913 return "Can't get wave download buffer";
918 wave->dlInfo.dwDLType = DMUS_DOWNLOADINFO_WAVE;
919 wave->dlInfo.cbSize = wave_size;
920 wave->dlInfo.dwDLId = dlid_wave + i;
921 wave->dlInfo.dwNumOffsetTableEntries = 2;
922 wave->ulOffsetTable[0] = offsetof(WAVE_DOWNLOAD, dmWave);
923 wave->ulOffsetTable[1] = offsetof(WAVE_DOWNLOAD, dmWaveData);
924 wave->dmWave.ulWaveDataIdx = 1;
925 MemCpyT((PCMWAVEFORMAT *)&wave->dmWave.WaveformatEx, &dls_file.waves[i].fmt, 1);
926 wave->dmWaveData.cbSize = (DWORD)dls_file.waves[i].data.size();
927 MemCpyT(wave->dmWaveData.byData, &dls_file.waves[i].data[0], dls_file.waves[i].data.size());
930 if (FAILED(download_port->Download(dl_wave))) {
931 download_port->Release();
932 return "Downloading DLS wave failed";
937 for (DWORD i = 0; i < dls_file.instruments.size(); i++) {
938 DWORD offsets = 1 + (DWORD)dls_file.instruments[i].regions.size();
941 size_t i_size =
sizeof(DMUS_DOWNLOADINFO) +
sizeof(DMUS_INSTRUMENT);
942 if (!dls_file.instruments[i].articulators.empty()) {
945 i_size +=
sizeof(DMUS_ARTICULATION2) +
sizeof(CONNECTIONLIST) +
sizeof(CONNECTION) * dls_file.instruments[i].articulators.size();
948 for (std::vector<DLSFile::DLSRegion>::iterator rgn = dls_file.instruments[i].regions.begin(); rgn != dls_file.instruments[i].regions.end(); rgn++) {
949 if (!rgn->articulators.empty()) {
951 i_size +=
sizeof(DMUS_ARTICULATION2) +
sizeof(CONNECTIONLIST) +
sizeof(CONNECTION) * rgn->articulators.size();
956 if (rgn->wave_sample.cbSize != 0) {
957 i_size +=
sizeof(DMUS_REGION) -
sizeof(DMUS_REGION::WLOOP) +
sizeof(WLOOP) * rgn->wave_loops.size();
959 i_size +=
sizeof(DMUS_REGION) -
sizeof(DMUS_REGION::WLOOP) +
sizeof(WLOOP) * dls_file.waves[dls_file.pool_cues[rgn->wave.ulTableIndex].ulOffset].wave_loops.size();
963 i_size += offsets *
sizeof(ULONG);
966 IDirectMusicDownload *dl_inst =
nullptr;
967 if (FAILED(download_port->AllocateBuffer((DWORD)i_size, &dl_inst))) {
968 download_port->Release();
969 return "Can't allocate instrument download buffer";
974 if (FAILED(dl_inst->GetBuffer((LPVOID *)&instrument, &inst_size))) {
976 download_port->Release();
977 return "Can't get instrument download buffer";
979 char *inst_base = (
char *)instrument;
982 DMUS_DOWNLOADINFO *d_info = (DMUS_DOWNLOADINFO *)instrument;
983 d_info->dwDLType = DMUS_DOWNLOADINFO_INSTRUMENT2;
984 d_info->cbSize = inst_size;
985 d_info->dwDLId = dlid_inst + i;
986 d_info->dwNumOffsetTableEntries = offsets;
987 instrument = d_info + 1;
990 ULONG *offset_table = (ULONG *)instrument;
991 instrument = offset_table + offsets;
995 DMUS_INSTRUMENT *inst_data = (DMUS_INSTRUMENT *)instrument;
997 offset_table[last_offset++] = (
char *)inst_data - inst_base;
998 inst_data->ulPatch = (dls_file.instruments[i].hdr.Locale.ulBank & F_INSTRUMENT_DRUMS) | ((dls_file.instruments[i].hdr.Locale.ulBank & 0x7F7F) << 8) | (dls_file.instruments[i].hdr.Locale.ulInstrument & 0x7F);
999 instrument = inst_data + 1;
1002 if (!dls_file.instruments[i].articulators.empty()) {
1003 inst_data->ulGlobalArtIdx = last_offset;
1004 offset_table[last_offset++] = (
char *)instrument - inst_base;
1005 offset_table[last_offset++] = (
char *)instrument +
sizeof(DMUS_ARTICULATION2) - inst_base;
1007 instrument = DownloadArticulationData(inst_data->ulGlobalArtIdx, instrument, dls_file.instruments[i].articulators);
1008 assert((
char *)instrument - inst_base <= (ptrdiff_t)inst_size);
1012 inst_data->ulFirstRegionIdx = last_offset;
1013 for (uint j = 0; j < dls_file.instruments[i].regions.size(); j++) {
1016 DMUS_REGION *inst_region = (DMUS_REGION *)instrument;
1017 offset_table[last_offset++] = (
char *)inst_region - inst_base;
1018 inst_region->RangeKey = rgn.hdr.RangeKey;
1019 inst_region->RangeVelocity = rgn.hdr.RangeVelocity;
1020 inst_region->fusOptions = rgn.hdr.fusOptions;
1021 inst_region->usKeyGroup = rgn.hdr.usKeyGroup;
1022 inst_region->ulFirstExtCkIdx = 0;
1024 ULONG wave_id = dls_file.pool_cues[rgn.wave.ulTableIndex].ulOffset;
1025 inst_region->WaveLink = rgn.wave;
1026 inst_region->WaveLink.ulTableIndex = wave_id + dlid_wave;
1029 if (rgn.wave_sample.cbSize != 0) {
1030 inst_region->WSMP = rgn.wave_sample;
1031 if (!rgn.wave_loops.empty())
MemCpyT(inst_region->WLOOP, &rgn.wave_loops.front(), rgn.wave_loops.size());
1033 instrument = (
char *)(inst_region + 1) -
sizeof(DMUS_REGION::WLOOP) +
sizeof(WLOOP) * rgn.wave_loops.size();
1035 inst_region->WSMP = rgn.wave_sample;
1036 if (!dls_file.waves[wave_id].wave_loops.empty())
MemCpyT(inst_region->WLOOP, &dls_file.waves[wave_id].wave_loops.front(), dls_file.waves[wave_id].wave_loops.size());
1038 instrument = (
char *)(inst_region + 1) -
sizeof(DMUS_REGION::WLOOP) +
sizeof(WLOOP) * dls_file.waves[wave_id].wave_loops.size();
1042 if (!rgn.articulators.empty()) {
1043 inst_region->ulRegionArtIdx = last_offset;
1044 offset_table[last_offset++] = (
char *)instrument - inst_base;
1045 offset_table[last_offset++] = (
char *)instrument +
sizeof(DMUS_ARTICULATION2) - inst_base;
1047 instrument = DownloadArticulationData(inst_region->ulRegionArtIdx, instrument, rgn.articulators);
1049 inst_region->ulRegionArtIdx = 0;
1051 assert((
char *)instrument - inst_base <= (ptrdiff_t)inst_size);
1054 inst_region->ulNextRegionIdx = j < dls_file.instruments[i].regions.size() - 1 ? last_offset : 0;
1058 if (FAILED(download_port->Download(dl_inst))) {
1059 download_port->Release();
1060 return "Downloading DLS instrument failed";
1064 download_port->Release();
1074 if (FAILED(CoInitializeEx(
nullptr, COINIT_MULTITHREADED)))
return "COM initialization failed";
1077 if (FAILED(CoCreateInstance(
1084 return "Failed to create the music object";
1088 if (FAILED(
_music->SetDirectSound(
nullptr,
nullptr)))
return "Can't set DirectSound interface";
1095 if (_debug_driver_level > 0) {
1097 char desc[DMUS_MAX_DESCRIPTION];
1101 caps.dwSize =
sizeof(DMUS_PORTCAPS);
1103 Debug(driver, 1,
"Detected DirectMusic ports:");
1104 for (
int i = 0;
_music->EnumPort(i, &caps) == S_OK; i++) {
1105 if (caps.dwClass == DMUS_PC_OUTPUTCLASS) {
1106 Debug(driver, 1,
" {}: {}{}", i,
convert_from_fs(caps.wszDescription, desc), i == pIdx ?
" (selected)" :
"");
1116 caps.dwSize =
sizeof(DMUS_PORTCAPS);
1117 if (FAILED(
_music->EnumPort(pIdx, &caps)))
return "Supplied port parameter is not a valid port";
1118 if (caps.dwClass != DMUS_PC_OUTPUTCLASS)
return "Supplied port parameter is not an output port";
1119 guidPort = caps.guidPort;
1121 if (FAILED(
_music->GetDefaultPort(&guidPort)))
return "Can't query default music port";
1125 DMUS_PORTPARAMS params;
1127 params.dwSize =
sizeof(DMUS_PORTPARAMS);
1128 params.dwValidParams = DMUS_PORTPARAMS_CHANNELGROUPS;
1129 params.dwChannelGroups = 1;
1130 if (FAILED(
_music->CreatePort(guidPort, ¶ms, &
_port,
nullptr)))
return "Failed to create port";
1132 if (FAILED(
_port->Activate(TRUE)))
return "Failed to activate port";
1135 DMUS_BUFFERDESC desc;
1137 desc.dwSize =
sizeof(DMUS_BUFFERDESC);
1138 desc.guidBufferFormat = KSDATAFORMAT_SUBTYPE_DIRECTMUSIC;
1139 desc.cbBuffer = 1024;
1140 if (FAILED(
_music->CreateMusicBuffer(&desc, &
_buffer,
nullptr)))
return "Failed to create music buffer";
1143 const char *dls = LoadDefaultDLSFile(
GetDriverParam(parm,
"dls"));
1144 if (dls !=
nullptr)
return dls;
1147 _thread_event = CreateEvent(
nullptr, FALSE, FALSE,
nullptr);
1148 if (
_thread_event ==
nullptr)
return "Can't create thread shutdown event";
1152 return std::nullopt;
1156 MusicDriver_DMusic::~MusicDriver_DMusic()
1164 if (_dmusic_thread.joinable()) {
1165 _playback.shutdown =
true;
1172 IDirectMusicPortDownload *download_port =
nullptr;
1173 _port->QueryInterface(IID_IDirectMusicPortDownload, (LPVOID *)&download_port);
1177 for (std::vector<IDirectMusicDownload *>::reverse_iterator i =
_dls_downloads.rbegin(); download_port !=
nullptr && i !=
_dls_downloads.rend(); i++) {
1178 download_port->Unload(*i);
1183 if (download_port !=
nullptr) download_port->Release();
1191 if (
_port !=
nullptr) {
1192 _port->Activate(FALSE);
1212 if (!_playback.next_file.LoadSong(song))
return;
1216 _playback.next_segment.loop = song.
loop;
1218 _playback.do_start =
true;
1225 _playback.do_stop =
true;
1232 return _playback.playing || _playback.do_start;
1238 _playback.new_volume = vol;
Factory for the DirectX music player.
static std::optional< FileHandle > Open(const std::string &filename, const std::string &mode)
Open an RAII file handle if possible.
void SetVolume(uint8_t vol) override
Set the volume, if possible.
void StopSong() override
Stop playing the current song.
std::optional< std::string_view > Start(const StringList ¶m) override
Start this driver.
bool IsSongPlaying() override
Are we currently playing a song?
void Stop() override
Stop this driver.
void PlaySong(const MusicSongInfo &song) override
Play a particular song.
#define Debug(category, level, format_string,...)
Ouptut a line of debugging information.
bool playing
flag indicating that playback is active
uint8_t new_volume
volume setting to change to
bool shutdown
flag to indicate playback thread shutdown
static IDirectMusicBuffer * _buffer
The buffer object collects the data to sent.
bool do_stop
flag for stopping playback at next opportunity
int preload_time
preload time for music blocks.
static const int MIDITIME_TO_REFTIME
Time base of the midi file reader is 1 us.
static std::thread _dmusic_thread
Handle to our worker thread.
MidiFile next_file
upcoming file to play
static IDirectMusicPort * _port
The port object lets us send MIDI data to the synthesizer.
bool do_start
flag for starting playback of next_file at next opportunity
static std::vector< IDirectMusicDownload * > _dls_downloads
List of downloaded DLS instruments.
static HANDLE _thread_event
Event to signal the thread that it should look at a state change.
PACK_N(struct ChunkHeader { FOURCC type;DWORD length;}, 2)
A RIFF chunk header.
static const int MS_TO_REFTIME
DirectMusic time base is 100 ns.
static std::mutex _thread_mutex
Lock access to playback data that is not thread-safe.
static IDirectMusic * _music
The direct music object manages buffers and ports.
PlaybackSegment next_segment
segment info for upcoming file
static void TransmitNotesOff(IDirectMusicBuffer *buffer, REFERENCE_TIME block_time, REFERENCE_TIME cur_time)
Transmit 'Note off' messages to all MIDI channels.
Base of playing music via DirectMusic.
const char * GetDriverParam(const StringList &parm, const char *name)
Get a string parameter the list of parameters.
int GetDriverParamInt(const StringList &parm, const char *name, int def)
Get an integer parameter the list of parameters.
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
void MemCpyT(T *destination, const T *source, size_t num=1)
Type-safe version of memcpy().
void MemSetT(T *ptr, uint8_t value, size_t num=1)
Type-safe version of memset().
#define lengthof(array)
Return the length of an fixed size array.
std::vector< std::string > StringList
Type for a list of strings.
Instrument definition read from a DLS file.
An instrument region maps a note range to wave data.
Wave data definition from a DLS file.
bool ReadDLSInstrumentList(FileHandle &f, DWORD list_length)
Load a list of instruments from a DLS file.
bool LoadFile(const std::string &file)
Try loading a DLS file into memory.
bool ReadDLSWaveList(FileHandle &f, DWORD list_length)
Load a list of waves from a DLS file.
bool ReadDLSRegionList(FileHandle &f, DWORD list_length, DLSInstrument &instrument)
Load a list of regions from a DLS file.
bool ReadDLSWave(FileHandle &f, DWORD list_length, long offset)
Load a single wave from a DLS file.
bool ReadDLSRegion(FileHandle &f, DWORD list_length, std::vector< DLSRegion > &out)
Load a single region from a DLS file.
bool ReadDLSInstrument(FileHandle &f, DWORD list_length)
Load a single instrument from a DLS file.
bool ReadDLSArticulation(FileHandle &f, DWORD list_length, std::vector< CONNECTION > &out)
Load an articulation structure from a DLS file.
std::vector< uint8_t > data
raw midi data contained in block
uint32_t realtime
real-time (microseconds) since start of file this block should be triggered at
uint32_t ticktime
tick number since start of file this block should be triggered at
void MoveFrom(MidiFile &other)
Move data from other to this, and clears other.
std::vector< DataBlock > blocks
sequential time-annotated data of file, merged to a single track
Metadata about a music track.
int override_start
MIDI ticks to skip over in beginning.
bool loop
song should play in a tight loop if possible, never ending
int override_end
MIDI tick to end the song at (0 if no override)
bool StartNewThread(std::thread *thr, const char *name, TFn &&_Fx, TArgs &&... _Ax)
Start a new thread.
std::string FS2OTTD(const std::wstring &name)
Convert to OpenTTD's encoding from a wide string.
char * convert_from_fs(const std::wstring_view src, std::span< char > dst_buf)
Convert to OpenTTD's encoding from that of the environment in UNICODE.
uint8_t current_volume
current effective volume setting
MidiFile current_file
file currently being played from
PlaybackSegment current_segment
segment info for current playback
size_t current_block
next block index to send
std::mutex lock
synchronization for playback status fields
uint8_t channel_volumes[16]
last seen volume controller values in raw data
DWORD playback_start_time
timestamp current file began playback