Files
@ r24444:628513f2f77f
Branch filter:
Location: cpp/openttd-patchpack/source/src/music/dmusic.cpp
r24444:628513f2f77f
41.8 KiB
text/x-c
Update: Translations from eints
korean: 29 changes by telk5093
finnish: 8 changes by hpiirai
slovak: 6 changes by FuryPapaya
french: 6 changes by glx22
korean: 29 changes by telk5093
finnish: 8 changes by hpiirai
slovak: 6 changes by FuryPapaya
french: 6 changes by glx22
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 | /*
* This file is part of OpenTTD.
* OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
* OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
*/
/** @file dmusic.cpp Playing music via DirectMusic. */
#define INITGUID
#include "../stdafx.h"
#ifdef WIN32_LEAN_AND_MEAN
# undef WIN32_LEAN_AND_MEAN // Don't exclude rarely-used stuff from Windows headers
#endif
#include "../debug.h"
#include "../os/windows/win32.h"
#include "../core/mem_func.hpp"
#include "../thread.h"
#include "../fileio_func.h"
#include "../base_media_base.h"
#include "dmusic.h"
#include "midifile.hpp"
#include "midi.h"
#include <windows.h>
#include <dmksctrl.h>
#include <dmusicc.h>
#include <algorithm>
#include <mutex>
#include "../safeguards.h"
#if defined(_MSC_VER)
# pragma comment(lib, "ole32.lib")
#endif /* defined(_MSC_VER) */
static const int MS_TO_REFTIME = 1000 * 10; ///< DirectMusic time base is 100 ns.
static const int MIDITIME_TO_REFTIME = 10; ///< Time base of the midi file reader is 1 us.
#define FOURCC_INFO mmioFOURCC('I','N','F','O')
#define FOURCC_fmt mmioFOURCC('f','m','t',' ')
#define FOURCC_data mmioFOURCC('d','a','t','a')
/** A DLS file. */
struct DLSFile {
/** An instrument region maps a note range to wave data. */
struct DLSRegion {
RGNHEADER hdr;
WAVELINK wave;
WSMPL wave_sample;
std::vector<WLOOP> wave_loops;
std::vector<CONNECTION> articulators;
};
/** Instrument definition read from a DLS file. */
struct DLSInstrument {
INSTHEADER hdr;
std::vector<CONNECTION> articulators;
std::vector<DLSRegion> regions;
};
/** Wave data definition from a DLS file. */
struct DLSWave {
long file_offset;
PCMWAVEFORMAT fmt;
std::vector<BYTE> data;
WSMPL wave_sample;
std::vector<WLOOP> wave_loops;
bool operator ==(long offset) const {
return this->file_offset == offset;
}
};
std::vector<DLSInstrument> instruments;
std::vector<POOLCUE> pool_cues;
std::vector<DLSWave> waves;
/** Try loading a DLS file into memory. */
bool LoadFile(const TCHAR *file);
private:
/** Load an articulation structure from a DLS file. */
bool ReadDLSArticulation(FILE *f, DWORD list_length, std::vector<CONNECTION> &out);
/** Load a list of regions from a DLS file. */
bool ReadDLSRegionList(FILE *f, DWORD list_length, DLSInstrument &instrument);
/** Load a single region from a DLS file. */
bool ReadDLSRegion(FILE *f, DWORD list_length, std::vector<DLSRegion> &out);
/** Load a list of instruments from a DLS file. */
bool ReadDLSInstrumentList(FILE *f, DWORD list_length);
/** Load a single instrument from a DLS file. */
bool ReadDLSInstrument(FILE *f, DWORD list_length);
/** Load a list of waves from a DLS file. */
bool ReadDLSWaveList(FILE *f, DWORD list_length);
/** Load a single wave from a DLS file. */
bool ReadDLSWave(FILE *f, DWORD list_length, long offset);
};
/** A RIFF chunk header. */
PACK_N(struct ChunkHeader {
FOURCC type; ///< Chunk type.
DWORD length; ///< Length of the chunk, not including the chunk header itself.
}, 2);
/** Buffer format for a DLS wave download. */
PACK_N(struct WAVE_DOWNLOAD {
DMUS_DOWNLOADINFO dlInfo;
ULONG ulOffsetTable[2];
DMUS_WAVE dmWave;
DMUS_WAVEDATA dmWaveData;
}, 2);
struct PlaybackSegment {
uint32 start, end;
size_t start_block;
bool loop;
};
static struct {
bool shutdown; ///< flag to indicate playback thread shutdown
bool playing; ///< flag indicating that playback is active
bool do_start; ///< flag for starting playback of next_file at next opportunity
bool do_stop; ///< flag for stopping playback at next opportunity
int preload_time; ///< preload time for music blocks.
byte new_volume; ///< volume setting to change to
MidiFile next_file; ///< upcoming file to play
PlaybackSegment next_segment; ///< segment info for upcoming file
} _playback;
/** Handle to our worker thread. */
static std::thread _dmusic_thread;
/** Event to signal the thread that it should look at a state change. */
static HANDLE _thread_event = nullptr;
/** Lock access to playback data that is not thread-safe. */
static std::mutex _thread_mutex;
/** The direct music object manages buffers and ports. */
static IDirectMusic *_music = nullptr;
/** The port object lets us send MIDI data to the synthesizer. */
static IDirectMusicPort *_port = nullptr;
/** The buffer object collects the data to sent. */
static IDirectMusicBuffer *_buffer = nullptr;
/** List of downloaded DLS instruments. */
static std::vector<IDirectMusicDownload *> _dls_downloads;
static FMusicDriver_DMusic iFMusicDriver_DMusic;
bool DLSFile::ReadDLSArticulation(FILE *f, DWORD list_length, std::vector<CONNECTION> &out)
{
while (list_length > 0) {
ChunkHeader chunk;
if (fread(&chunk, sizeof(chunk), 1, f) != 1) return false;
list_length -= chunk.length + sizeof(chunk);
if (chunk.type == FOURCC_ART1) {
CONNECTIONLIST conns;
if (fread(&conns, sizeof(conns), 1, f) != 1) return false;
fseek(f, conns.cbSize - sizeof(conns), SEEK_CUR);
/* Read all defined articulations. */
for (ULONG i = 0; i < conns.cConnections; i++) {
CONNECTION con;
if (fread(&con, sizeof(con), 1, f) != 1) return false;
out.push_back(con);
}
} else {
fseek(f, chunk.length, SEEK_CUR);
}
}
return true;
}
bool DLSFile::ReadDLSRegion(FILE *f, DWORD list_length, std::vector<DLSRegion> &out)
{
out.push_back(DLSRegion());
DLSRegion ®ion = out.back();
/* Set default values. */
region.wave_sample.cbSize = 0;
while (list_length > 0) {
ChunkHeader chunk;
if (fread(&chunk, sizeof(chunk), 1, f) != 1) return false;
list_length -= chunk.length + sizeof(chunk);
if (chunk.type == FOURCC_LIST) {
/* Unwrap list header. */
if (fread(&chunk.type, sizeof(chunk.type), 1, f) != 1) return false;
chunk.length -= sizeof(chunk.type);
}
switch (chunk.type) {
case FOURCC_RGNH:
if (fread(®ion.hdr, sizeof(region.hdr), 1, f) != 1) return false;
break;
case FOURCC_WSMP:
if (fread(®ion.wave_sample, sizeof(region.wave_sample), 1, f) != 1) return false;
fseek(f, region.wave_sample.cbSize - sizeof(region.wave_sample), SEEK_CUR);
/* Read all defined sample loops. */
for (ULONG i = 0; i < region.wave_sample.cSampleLoops; i++) {
WLOOP loop;
if (fread(&loop, sizeof(loop), 1, f) != 1) return false;
region.wave_loops.push_back(loop);
}
break;
case FOURCC_WLNK:
if (fread(®ion.wave, sizeof(region.wave), 1, f) != 1) return false;
break;
case FOURCC_LART: // List chunk
if (!this->ReadDLSArticulation(f, chunk.length, region.articulators)) return false;
break;
case FOURCC_INFO:
/* We don't care about info stuff. */
fseek(f, chunk.length, SEEK_CUR);
break;
default:
DEBUG(driver, 7, "DLS: Ignoring unknown chunk %c%c%c%c", (char)(chunk.type & 0xFF), (char)((chunk.type >> 8) & 0xFF), (char)((chunk.type >> 16) & 0xFF), (char)((chunk.type >> 24) & 0xFF));
fseek(f, chunk.length, SEEK_CUR);
break;
}
}
return true;
}
bool DLSFile::ReadDLSRegionList(FILE *f, DWORD list_length, DLSInstrument &instrument)
{
while (list_length > 0) {
ChunkHeader chunk;
if (fread(&chunk, sizeof(chunk), 1, f) != 1) return false;
list_length -= chunk.length + sizeof(chunk);
if (chunk.type == FOURCC_LIST) {
FOURCC list_type;
if (fread(&list_type, sizeof(list_type), 1, f) != 1) return false;
if (list_type == FOURCC_RGN) {
this->ReadDLSRegion(f, chunk.length - sizeof(list_type), instrument.regions);
} else {
DEBUG(driver, 7, "DLS: Ignoring unknown list chunk of type %c%c%c%c", (char)(list_type & 0xFF), (char)((list_type >> 8) & 0xFF), (char)((list_type >> 16) & 0xFF), (char)((list_type >> 24) & 0xFF));
fseek(f, chunk.length - sizeof(list_type), SEEK_CUR);
}
} else {
DEBUG(driver, 7, "DLS: Ignoring chunk %c%c%c%c", (char)(chunk.type & 0xFF), (char)((chunk.type >> 8) & 0xFF), (char)((chunk.type >> 16) & 0xFF), (char)((chunk.type >> 24) & 0xFF));
fseek(f, chunk.length, SEEK_CUR);
}
}
return true;
}
bool DLSFile::ReadDLSInstrument(FILE *f, DWORD list_length)
{
this->instruments.push_back(DLSInstrument());
DLSInstrument &instrument = this->instruments.back();
while (list_length > 0) {
ChunkHeader chunk;
if (fread(&chunk, sizeof(chunk), 1, f) != 1) return false;
list_length -= chunk.length + sizeof(chunk);
if (chunk.type == FOURCC_LIST) {
/* Unwrap list header. */
if (fread(&chunk.type, sizeof(chunk.type), 1, f) != 1) return false;
chunk.length -= sizeof(chunk.type);
}
switch (chunk.type) {
case FOURCC_INSH:
if (fread(&instrument.hdr, sizeof(instrument.hdr), 1, f) != 1) return false;
break;
case FOURCC_LART: // List chunk
if (!this->ReadDLSArticulation(f, chunk.length, instrument.articulators)) return false;
break;
case FOURCC_LRGN: // List chunk
if (!this->ReadDLSRegionList(f, chunk.length, instrument)) return false;
break;
case FOURCC_INFO:
/* We don't care about info stuff. */
fseek(f, chunk.length, SEEK_CUR);
break;
default:
DEBUG(driver, 7, "DLS: Ignoring unknown chunk %c%c%c%c", (char)(chunk.type & 0xFF), (char)((chunk.type >> 8) & 0xFF), (char)((chunk.type >> 16) & 0xFF), (char)((chunk.type >> 24) & 0xFF));
fseek(f, chunk.length, SEEK_CUR);
break;
}
}
return true;
}
bool DLSFile::ReadDLSInstrumentList(FILE *f, DWORD list_length)
{
while (list_length > 0) {
ChunkHeader chunk;
if (fread(&chunk, sizeof(chunk), 1, f) != 1) return false;
list_length -= chunk.length + sizeof(chunk);
if (chunk.type == FOURCC_LIST) {
FOURCC list_type;
if (fread(&list_type, sizeof(list_type), 1, f) != 1) return false;
if (list_type == FOURCC_INS) {
DEBUG(driver, 6, "DLS: Reading instrument %d", (int)instruments.size());
if (!this->ReadDLSInstrument(f, chunk.length - sizeof(list_type))) return false;
} else {
DEBUG(driver, 7, "DLS: Ignoring unknown list chunk of type %c%c%c%c", (char)(list_type & 0xFF), (char)((list_type >> 8) & 0xFF), (char)((list_type >> 16) & 0xFF), (char)((list_type >> 24) & 0xFF));
fseek(f, chunk.length - sizeof(list_type), SEEK_CUR);
}
} else {
DEBUG(driver, 7, "DLS: Ignoring chunk %c%c%c%c", (char)(chunk.type & 0xFF), (char)((chunk.type >> 8) & 0xFF), (char)((chunk.type >> 16) & 0xFF), (char)((chunk.type >> 24) & 0xFF));
fseek(f, chunk.length, SEEK_CUR);
}
}
return true;
}
bool DLSFile::ReadDLSWave(FILE *f, DWORD list_length, long offset)
{
this->waves.push_back(DLSWave());
DLSWave &wave = this->waves.back();
/* Set default values. */
MemSetT(&wave.wave_sample, 0);
wave.wave_sample.cbSize = sizeof(WSMPL);
wave.wave_sample.usUnityNote = 60;
wave.file_offset = offset; // Store file offset so we can resolve the wave pool table later on.
while (list_length > 0) {
ChunkHeader chunk;
if (fread(&chunk, sizeof(chunk), 1, f) != 1) return false;
list_length -= chunk.length + sizeof(chunk);
if (chunk.type == FOURCC_LIST) {
/* Unwrap list header. */
if (fread(&chunk.type, sizeof(chunk.type), 1, f) != 1) return false;
chunk.length -= sizeof(chunk.type);
}
switch (chunk.type) {
case FOURCC_fmt:
if (fread(&wave.fmt, sizeof(wave.fmt), 1, f) != 1) return false;
if (chunk.length > sizeof(wave.fmt)) fseek(f, chunk.length - sizeof(wave.fmt), SEEK_CUR);
break;
case FOURCC_WSMP:
if (fread(&wave.wave_sample, sizeof(wave.wave_sample), 1, f) != 1) return false;
fseek(f, wave.wave_sample.cbSize - sizeof(wave.wave_sample), SEEK_CUR);
/* Read all defined sample loops. */
for (ULONG i = 0; i < wave.wave_sample.cSampleLoops; i++) {
WLOOP loop;
if (fread(&loop, sizeof(loop), 1, f) != 1) return false;
wave.wave_loops.push_back(loop);
}
break;
case FOURCC_data:
wave.data.resize(chunk.length);
if (fread(&wave.data[0], sizeof(BYTE), wave.data.size(), f) != wave.data.size()) return false;
break;
case FOURCC_INFO:
/* We don't care about info stuff. */
fseek(f, chunk.length, SEEK_CUR);
break;
default:
DEBUG(driver, 7, "DLS: Ignoring unknown chunk %c%c%c%c", (char)(chunk.type & 0xFF), (char)((chunk.type >> 8) & 0xFF), (char)((chunk.type >> 16) & 0xFF), (char)((chunk.type >> 24) & 0xFF));
fseek(f, chunk.length, SEEK_CUR);
break;
}
}
return true;
}
bool DLSFile::ReadDLSWaveList(FILE *f, DWORD list_length)
{
long base_offset = ftell(f);
while (list_length > 0) {
long chunk_offset = ftell(f);
ChunkHeader chunk;
if (fread(&chunk, sizeof(chunk), 1, f) != 1) return false;
list_length -= chunk.length + sizeof(chunk);
if (chunk.type == FOURCC_LIST) {
FOURCC list_type;
if (fread(&list_type, sizeof(list_type), 1, f) != 1) return false;
if (list_type == FOURCC_wave) {
DEBUG(driver, 6, "DLS: Reading wave %d", (int)waves.size());
if (!this->ReadDLSWave(f, chunk.length - sizeof(list_type), chunk_offset - base_offset)) return false;
} else {
DEBUG(driver, 7, "DLS: Ignoring unknown list chunk of type %c%c%c%c", (char)(list_type & 0xFF), (char)((list_type >> 8) & 0xFF), (char)((list_type >> 16) & 0xFF), (char)((list_type >> 24) & 0xFF));
fseek(f, chunk.length - sizeof(list_type), SEEK_CUR);
}
} else {
DEBUG(driver, 7, "DLS: Ignoring chunk %c%c%c%c", (char)(chunk.type & 0xFF), (char)((chunk.type >> 8) & 0xFF), (char)((chunk.type >> 16) & 0xFF), (char)((chunk.type >> 24) & 0xFF));
fseek(f, chunk.length, SEEK_CUR);
}
}
return true;
}
bool DLSFile::LoadFile(const TCHAR *file)
{
DEBUG(driver, 2, "DMusic: Try to load DLS file %s", FS2OTTD(file));
FILE *f = _tfopen(file, _T("rb"));
if (f == nullptr) return false;
FileCloser f_scope(f);
/* Check DLS file header. */
ChunkHeader hdr;
FOURCC dls_type;
if (fread(&hdr, sizeof(hdr), 1, f) != 1) return false;
if (fread(&dls_type, sizeof(dls_type), 1, f) != 1) return false;
if (hdr.type != FOURCC_RIFF || dls_type != FOURCC_DLS) return false;
hdr.length -= sizeof(FOURCC);
DEBUG(driver, 2, "DMusic: Parsing DLS file");
DLSHEADER header;
MemSetT(&header, 0);
/* Iterate over all chunks in the file. */
while (hdr.length > 0) {
ChunkHeader chunk;
if (fread(&chunk, sizeof(chunk), 1, f) != 1) return false;
hdr.length -= chunk.length + sizeof(chunk);
if (chunk.type == FOURCC_LIST) {
/* Unwrap list header. */
if (fread(&chunk.type, sizeof(chunk.type), 1, f) != 1) return false;
chunk.length -= sizeof(chunk.type);
}
switch (chunk.type) {
case FOURCC_COLH:
if (fread(&header, sizeof(header), 1, f) != 1) return false;
break;
case FOURCC_LINS: // List chunk
if (!this->ReadDLSInstrumentList(f, chunk.length)) return false;
break;
case FOURCC_WVPL: // List chunk
if (!this->ReadDLSWaveList(f, chunk.length)) return false;
break;
case FOURCC_PTBL:
POOLTABLE ptbl;
if (fread(&ptbl, sizeof(ptbl), 1, f) != 1) return false;
fseek(f, ptbl.cbSize - sizeof(ptbl), SEEK_CUR);
/* Read all defined cues. */
for (ULONG i = 0; i < ptbl.cCues; i++) {
POOLCUE cue;
if (fread(&cue, sizeof(cue), 1, f) != 1) return false;
this->pool_cues.push_back(cue);
}
break;
case FOURCC_INFO:
/* We don't care about info stuff. */
fseek(f, chunk.length, SEEK_CUR);
break;
default:
DEBUG(driver, 7, "DLS: Ignoring unknown chunk %c%c%c%c", (char)(chunk.type & 0xFF), (char)((chunk.type >> 8) & 0xFF), (char)((chunk.type >> 16) & 0xFF), (char)((chunk.type >> 24) & 0xFF));
fseek(f, chunk.length, SEEK_CUR);
break;
}
}
/* Have we read as many instruments as indicated? */
if (header.cInstruments != this->instruments.size()) return false;
/* Resolve wave pool table. */
for (std::vector<POOLCUE>::iterator cue = this->pool_cues.begin(); cue != this->pool_cues.end(); cue++) {
std::vector<DLSWave>::iterator w = std::find(this->waves.begin(), this->waves.end(), cue->ulOffset);
if (w != this->waves.end()) {
cue->ulOffset = (ULONG)(w - this->waves.begin());
} else {
cue->ulOffset = 0;
}
}
return true;
}
static byte ScaleVolume(byte original, byte scale)
{
return original * scale / 127;
}
static void TransmitChannelMsg(IDirectMusicBuffer *buffer, REFERENCE_TIME rt, byte status, byte p1, byte p2 = 0)
{
if (buffer->PackStructured(rt, 0, status | (p1 << 8) | (p2 << 16)) == E_OUTOFMEMORY) {
/* Buffer is full, clear it and try again. */
_port->PlayBuffer(buffer);
buffer->Flush();
buffer->PackStructured(rt, 0, status | (p1 << 8) | (p2 << 16));
}
}
static void TransmitSysex(IDirectMusicBuffer *buffer, REFERENCE_TIME rt, const byte *&msg_start, size_t &remaining)
{
/* Find end of message. */
const byte *msg_end = msg_start;
while (*msg_end != MIDIST_ENDSYSEX) msg_end++;
msg_end++; // Also include SysEx end byte.
if (buffer->PackUnstructured(rt, 0, msg_end - msg_start, const_cast<LPBYTE>(msg_start)) == E_OUTOFMEMORY) {
/* Buffer is full, clear it and try again. */
_port->PlayBuffer(buffer);
buffer->Flush();
buffer->PackUnstructured(rt, 0, msg_end - msg_start, const_cast<LPBYTE>(msg_start));
}
/* Update position in buffer. */
remaining -= msg_end - msg_start;
msg_start = msg_end;
}
static void TransmitStandardSysex(IDirectMusicBuffer *buffer, REFERENCE_TIME rt, MidiSysexMessage msg)
{
size_t length = 0;
const byte *data = MidiGetStandardSysexMessage(msg, length);
TransmitSysex(buffer, rt, data, length);
}
/** Transmit 'Note off' messages to all MIDI channels. */
static void TransmitNotesOff(IDirectMusicBuffer *buffer, REFERENCE_TIME block_time, REFERENCE_TIME cur_time)
{
for (int ch = 0; ch < 16; ch++) {
TransmitChannelMsg(_buffer, block_time + 10, MIDIST_CONTROLLER | ch, MIDICT_MODE_ALLNOTESOFF, 0);
TransmitChannelMsg(_buffer, block_time + 10, MIDIST_CONTROLLER | ch, MIDICT_SUSTAINSW, 0);
TransmitChannelMsg(_buffer, block_time + 10, MIDIST_CONTROLLER | ch, MIDICT_MODE_RESETALLCTRL, 0);
}
/* Performing a GM reset stops all sound and resets all parameters. */
TransmitStandardSysex(_buffer, block_time + 20, MidiSysexMessage::ResetGM);
TransmitStandardSysex(_buffer, block_time + 30, MidiSysexMessage::RolandSetReverb);
/* Explicitly flush buffer to make sure the messages are processed,
* as we want sound to stop immediately. */
_port->PlayBuffer(_buffer);
_buffer->Flush();
/* Wait until message time has passed. */
Sleep(Clamp((block_time - cur_time) / MS_TO_REFTIME, 5, 1000));
}
static void MidiThreadProc()
{
DEBUG(driver, 2, "DMusic: Entering playback thread");
REFERENCE_TIME last_volume_time = 0; // timestamp of the last volume change
REFERENCE_TIME block_time = 0; // timestamp of the last block sent to the port
REFERENCE_TIME playback_start_time; // timestamp current file began playback
MidiFile current_file; // file currently being played from
PlaybackSegment current_segment; // segment info for current playback
size_t current_block = 0; // next block index to send
byte current_volume = 0; // current effective volume setting
byte channel_volumes[16]; // last seen volume controller values in raw data
/* Get pointer to the reference clock of our output port. */
IReferenceClock *clock;
_port->GetLatencyClock(&clock);
REFERENCE_TIME cur_time;
clock->GetTime(&cur_time);
_port->PlayBuffer(_buffer);
_buffer->Flush();
DWORD next_timeout = 1000;
while (true) {
/* Wait for a signal from the GUI thread or until the time for the next event has come. */
DWORD wfso = WaitForSingleObject(_thread_event, next_timeout);
if (_playback.shutdown) {
_playback.playing = false;
break;
}
if (_playback.do_stop) {
DEBUG(driver, 2, "DMusic thread: Stopping playback");
/* Turn all notes off and wait a bit to allow the messages to be handled. */
clock->GetTime(&cur_time);
TransmitNotesOff(_buffer, block_time, cur_time);
_playback.playing = false;
_playback.do_stop = false;
block_time = 0;
next_timeout = 1000;
continue;
}
if (wfso == WAIT_OBJECT_0) {
if (_playback.do_start) {
DEBUG(driver, 2, "DMusic thread: Starting playback");
{
/* New scope to limit the time the mutex is locked. */
std::lock_guard<std::mutex> lock(_thread_mutex);
current_file.MoveFrom(_playback.next_file);
std::swap(_playback.next_segment, current_segment);
current_segment.start_block = 0;
current_block = 0;
_playback.playing = true;
_playback.do_start = false;
}
/* Reset playback device between songs. */
clock->GetTime(&cur_time);
TransmitNotesOff(_buffer, block_time, cur_time);
MemSetT<byte>(channel_volumes, 127, lengthof(channel_volumes));
/* Take the current time plus the preload time as the music start time. */
clock->GetTime(&playback_start_time);
playback_start_time += _playback.preload_time * MS_TO_REFTIME;
}
}
if (_playback.playing) {
/* skip beginning of file? */
if (current_segment.start > 0 && current_block == 0 && current_segment.start_block == 0) {
/* find first block after start time and pretend playback started earlier
* this is to allow all blocks prior to the actual start to still affect playback,
* as they may contain important controller and program changes */
size_t preload_bytes = 0;
for (size_t bl = 0; bl < current_file.blocks.size(); bl++) {
MidiFile::DataBlock &block = current_file.blocks[bl];
preload_bytes += block.data.size();
if (block.ticktime >= current_segment.start) {
if (current_segment.loop) {
DEBUG(driver, 2, "DMusic: timer: loop from block %d (ticktime %d, realtime %.3f, bytes %d)", (int)bl, (int)block.ticktime, ((int)block.realtime) / 1000.0, (int)preload_bytes);
current_segment.start_block = bl;
break;
} else {
/* Skip the transmission delay compensation performed in the Win32 MIDI driver.
* The DMusic driver will most likely be used with the MS softsynth, which is not subject to transmission delays.
*/
DEBUG(driver, 2, "DMusic: timer: start from block %d (ticktime %d, realtime %.3f, bytes %d)", (int)bl, (int)block.ticktime, ((int)block.realtime) / 1000.0, (int)preload_bytes);
playback_start_time -= block.realtime * MIDITIME_TO_REFTIME;
break;
}
}
}
}
/* Get current playback timestamp. */
REFERENCE_TIME current_time;
clock->GetTime(¤t_time);
/* Check for volume change. */
if (current_volume != _playback.new_volume) {
if (current_time - last_volume_time > 10 * MS_TO_REFTIME) {
DEBUG(driver, 2, "DMusic thread: volume change");
current_volume = _playback.new_volume;
last_volume_time = current_time;
for (int ch = 0; ch < 16; ch++) {
int vol = ScaleVolume(channel_volumes[ch], current_volume);
TransmitChannelMsg(_buffer, block_time + 1, MIDIST_CONTROLLER | ch, MIDICT_CHANVOLUME, vol);
}
_port->PlayBuffer(_buffer);
_buffer->Flush();
}
}
while (current_block < current_file.blocks.size()) {
MidiFile::DataBlock &block = current_file.blocks[current_block];
/* check that block isn't at end-of-song override */
if (current_segment.end > 0 && block.ticktime >= current_segment.end) {
if (current_segment.loop) {
DEBUG(driver, 2, "DMusic thread: Looping song");
current_block = current_segment.start_block;
playback_start_time = current_time - current_file.blocks[current_block].realtime * MIDITIME_TO_REFTIME;
} else {
_playback.do_stop = true;
}
next_timeout = 0;
break;
}
/* check that block is not in the future */
REFERENCE_TIME playback_time = current_time - playback_start_time;
if (block.realtime * MIDITIME_TO_REFTIME > playback_time + 3 *_playback.preload_time * MS_TO_REFTIME) {
/* Stop the thread loop until we are at the preload time of the next block. */
next_timeout = Clamp(((int64)block.realtime * MIDITIME_TO_REFTIME - playback_time) / MS_TO_REFTIME - _playback.preload_time, 0, 1000);
DEBUG(driver, 9, "DMusic thread: Next event in %lu ms (music %u, ref " OTTD_PRINTF64 ")", next_timeout, block.realtime * MIDITIME_TO_REFTIME, playback_time);
break;
}
/* Timestamp of the current block. */
block_time = playback_start_time + block.realtime * MIDITIME_TO_REFTIME;
DEBUG(driver, 9, "DMusic thread: Streaming block " PRINTF_SIZE " (cur=" OTTD_PRINTF64 ", block=" OTTD_PRINTF64 ")", current_block, (long long)(current_time / MS_TO_REFTIME), (long long)(block_time / MS_TO_REFTIME));
const byte *data = block.data.data();
size_t remaining = block.data.size();
byte last_status = 0;
while (remaining > 0) {
/* MidiFile ought to have converted everything out of running status,
* but handle it anyway just to be safe */
byte status = data[0];
if (status & 0x80) {
last_status = status;
data++;
remaining--;
} else {
status = last_status;
}
switch (status & 0xF0) {
case MIDIST_PROGCHG:
case MIDIST_CHANPRESS:
/* 2 byte channel messages */
TransmitChannelMsg(_buffer, block_time, status, data[0]);
data++;
remaining--;
break;
case MIDIST_NOTEOFF:
case MIDIST_NOTEON:
case MIDIST_POLYPRESS:
case MIDIST_PITCHBEND:
/* 3 byte channel messages */
TransmitChannelMsg(_buffer, block_time, status, data[0], data[1]);
data += 2;
remaining -= 2;
break;
case MIDIST_CONTROLLER:
/* controller change */
if (data[0] == MIDICT_CHANVOLUME) {
/* volume controller, adjust for user volume */
channel_volumes[status & 0x0F] = data[1];
int vol = ScaleVolume(data[1], current_volume);
TransmitChannelMsg(_buffer, block_time, status, data[0], vol);
} else {
/* handle other controllers normally */
TransmitChannelMsg(_buffer, block_time, status, data[0], data[1]);
}
data += 2;
remaining -= 2;
break;
case 0xF0:
/* system messages */
switch (status) {
case MIDIST_SYSEX: /* system exclusive */
TransmitSysex(_buffer, block_time, data, remaining);
break;
case MIDIST_TC_QFRAME: /* time code quarter frame */
case MIDIST_SONGSEL: /* song select */
data++;
remaining--;
break;
case MIDIST_SONGPOSPTR: /* song position pointer */
data += 2;
remaining -= 2;
break;
default: /* remaining have no data bytes */
break;
}
break;
}
}
current_block++;
}
/* Anything in the playback buffer? Send it down the port. */
DWORD used_buffer = 0;
_buffer->GetUsedBytes(&used_buffer);
if (used_buffer > 0) {
_port->PlayBuffer(_buffer);
_buffer->Flush();
}
/* end? */
if (current_block == current_file.blocks.size()) {
if (current_segment.loop) {
current_block = current_segment.start_block;
playback_start_time = block_time - current_file.blocks[current_block].realtime * MIDITIME_TO_REFTIME;
} else {
_playback.do_stop = true;
}
next_timeout = 0;
}
}
}
DEBUG(driver, 2, "DMusic: Exiting playback thread");
/* Turn all notes off and wait a bit to allow the messages to be handled by real hardware. */
clock->GetTime(&cur_time);
TransmitNotesOff(_buffer, block_time, cur_time);
Sleep(_playback.preload_time * 4);
clock->Release();
}
static void * DownloadArticulationData(int base_offset, void *data, const std::vector<CONNECTION> &artic)
{
DMUS_ARTICULATION2 *art = (DMUS_ARTICULATION2 *)data;
art->ulArtIdx = base_offset + 1;
art->ulFirstExtCkIdx = 0;
art->ulNextArtIdx = 0;
CONNECTIONLIST *con_list = (CONNECTIONLIST *)(art + 1);
con_list->cbSize = sizeof(CONNECTIONLIST);
con_list->cConnections = (ULONG)artic.size();
MemCpyT((CONNECTION *)(con_list + 1), &artic.front(), artic.size());
return (CONNECTION *)(con_list + 1) + artic.size();
}
static const char *LoadDefaultDLSFile(const char *user_dls)
{
DMUS_PORTCAPS caps;
MemSetT(&caps, 0);
caps.dwSize = sizeof(DMUS_PORTCAPS);
_port->GetCaps(&caps);
/* Nothing to unless it is a synth with instrument download that doesn't come with GM voices by default. */
if ((caps.dwFlags & (DMUS_PC_DLS | DMUS_PC_DLS2)) != 0 && (caps.dwFlags & DMUS_PC_GMINHARDWARE) == 0) {
DLSFile dls_file;
if (user_dls == nullptr) {
/* Try loading the default GM DLS file stored in the registry. */
HKEY hkDM;
if (SUCCEEDED(RegOpenKeyEx(HKEY_LOCAL_MACHINE, _T("Software\\Microsoft\\DirectMusic"), 0, KEY_READ, &hkDM))) {
TCHAR dls_path[MAX_PATH];
DWORD buf_size = sizeof(dls_path); // Buffer size as to be given in bytes!
if (SUCCEEDED(RegQueryValueEx(hkDM, _T("GMFilePath"), nullptr, nullptr, (LPBYTE)dls_path, &buf_size))) {
TCHAR expand_path[MAX_PATH * 2];
ExpandEnvironmentStrings(dls_path, expand_path, lengthof(expand_path));
if (!dls_file.LoadFile(expand_path)) DEBUG(driver, 1, "Failed to load default GM DLS file from registry");
}
RegCloseKey(hkDM);
}
/* If we couldn't load the file from the registry, try again at the default install path of the GM DLS file. */
if (dls_file.instruments.size() == 0) {
static const TCHAR *DLS_GM_FILE = _T("%windir%\\System32\\drivers\\gm.dls");
TCHAR path[MAX_PATH];
ExpandEnvironmentStrings(DLS_GM_FILE, path, lengthof(path));
if (!dls_file.LoadFile(path)) return "Can't load GM DLS collection";
}
} else {
if (!dls_file.LoadFile(OTTD2FS(user_dls))) return "Can't load GM DLS collection";
}
/* Get download port and allocate download IDs. */
IDirectMusicPortDownload *download_port = nullptr;
if (FAILED(_port->QueryInterface(IID_IDirectMusicPortDownload, (LPVOID *)&download_port))) return "Can't get download port";
DWORD dlid_wave = 0, dlid_inst = 0;
if (FAILED(download_port->GetDLId(&dlid_wave, (DWORD)dls_file.waves.size())) || FAILED(download_port->GetDLId(&dlid_inst, (DWORD)dls_file.instruments.size()))) {
download_port->Release();
return "Can't get enough DLS ids";
}
DWORD dwAppend = 0;
download_port->GetAppend(&dwAppend);
/* Download wave data. */
for (DWORD i = 0; i < dls_file.waves.size(); i++) {
IDirectMusicDownload *dl_wave = nullptr;
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))) {
download_port->Release();
return "Can't allocate wave download buffer";
}
WAVE_DOWNLOAD *wave;
DWORD wave_size = 0;
if (FAILED(dl_wave->GetBuffer((LPVOID *)&wave, &wave_size))) {
dl_wave->Release();
download_port->Release();
return "Can't get wave download buffer";
}
/* Fill download data. */
MemSetT(wave, 0);
wave->dlInfo.dwDLType = DMUS_DOWNLOADINFO_WAVE;
wave->dlInfo.cbSize = wave_size;
wave->dlInfo.dwDLId = dlid_wave + i;
wave->dlInfo.dwNumOffsetTableEntries = 2;
wave->ulOffsetTable[0] = offsetof(WAVE_DOWNLOAD, dmWave);
wave->ulOffsetTable[1] = offsetof(WAVE_DOWNLOAD, dmWaveData);
wave->dmWave.ulWaveDataIdx = 1;
MemCpyT((PCMWAVEFORMAT *)&wave->dmWave.WaveformatEx, &dls_file.waves[i].fmt, 1);
wave->dmWaveData.cbSize = (DWORD)dls_file.waves[i].data.size();
MemCpyT(wave->dmWaveData.byData, &dls_file.waves[i].data[0], dls_file.waves[i].data.size());
_dls_downloads.push_back(dl_wave);
if (FAILED(download_port->Download(dl_wave))) {
download_port->Release();
return "Downloading DLS wave failed";
}
}
/* Download instrument data. */
for (DWORD i = 0; i < dls_file.instruments.size(); i++) {
DWORD offsets = 1 + (DWORD)dls_file.instruments[i].regions.size();
/* Calculate download size for the instrument. */
size_t i_size = sizeof(DMUS_DOWNLOADINFO) + sizeof(DMUS_INSTRUMENT);
if (dls_file.instruments[i].articulators.size() > 0) {
/* Articulations are stored as two chunks, one containing meta data and one with the actual articulation data. */
offsets += 2;
i_size += sizeof(DMUS_ARTICULATION2) + sizeof(CONNECTIONLIST) + sizeof(CONNECTION) * dls_file.instruments[i].articulators.size();
}
for (std::vector<DLSFile::DLSRegion>::iterator rgn = dls_file.instruments[i].regions.begin(); rgn != dls_file.instruments[i].regions.end(); rgn++) {
if (rgn->articulators.size() > 0) {
offsets += 2;
i_size += sizeof(DMUS_ARTICULATION2) + sizeof(CONNECTIONLIST) + sizeof(CONNECTION) * rgn->articulators.size();
}
/* Region size depends on the number of wave loops. The size of the
* declared structure already accounts for one loop. */
if (rgn->wave_sample.cbSize != 0) {
i_size += sizeof(DMUS_REGION) - sizeof(DMUS_REGION::WLOOP) + sizeof(WLOOP) * rgn->wave_loops.size();
} else {
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();
}
}
i_size += offsets * sizeof(ULONG);
/* Allocate download buffer. */
IDirectMusicDownload *dl_inst = nullptr;
if (FAILED(download_port->AllocateBuffer((DWORD)i_size, &dl_inst))) {
download_port->Release();
return "Can't allocate instrument download buffer";
}
void *instrument;
DWORD inst_size = 0;
if (FAILED(dl_inst->GetBuffer((LPVOID *)&instrument, &inst_size))) {
dl_inst->Release();
download_port->Release();
return "Can't get instrument download buffer";
}
char *inst_base = (char *)instrument;
/* Fill download header. */
DMUS_DOWNLOADINFO *d_info = (DMUS_DOWNLOADINFO *)instrument;
d_info->dwDLType = DMUS_DOWNLOADINFO_INSTRUMENT2;
d_info->cbSize = inst_size;
d_info->dwDLId = dlid_inst + i;
d_info->dwNumOffsetTableEntries = offsets;
instrument = d_info + 1;
/* Download offset table; contains the offsets of all chunks relative to the buffer start. */
ULONG *offset_table = (ULONG *)instrument;
instrument = offset_table + offsets;
int last_offset = 0;
/* Instrument header. */
DMUS_INSTRUMENT *inst_data = (DMUS_INSTRUMENT *)instrument;
MemSetT(inst_data, 0);
offset_table[last_offset++] = (char *)inst_data - inst_base;
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);
instrument = inst_data + 1;
/* Write global articulations. */
if (dls_file.instruments[i].articulators.size() > 0) {
inst_data->ulGlobalArtIdx = last_offset;
offset_table[last_offset++] = (char *)instrument - inst_base;
offset_table[last_offset++] = (char *)instrument + sizeof(DMUS_ARTICULATION2) - inst_base;
instrument = DownloadArticulationData(inst_data->ulGlobalArtIdx, instrument, dls_file.instruments[i].articulators);
assert((char *)instrument - inst_base <= (ptrdiff_t)inst_size);
}
/* Write out regions. */
inst_data->ulFirstRegionIdx = last_offset;
for (uint j = 0; j < dls_file.instruments[i].regions.size(); j++) {
DLSFile::DLSRegion &rgn = dls_file.instruments[i].regions[j];
DMUS_REGION *inst_region = (DMUS_REGION *)instrument;
offset_table[last_offset++] = (char *)inst_region - inst_base;
inst_region->RangeKey = rgn.hdr.RangeKey;
inst_region->RangeVelocity = rgn.hdr.RangeVelocity;
inst_region->fusOptions = rgn.hdr.fusOptions;
inst_region->usKeyGroup = rgn.hdr.usKeyGroup;
inst_region->ulFirstExtCkIdx = 0;
ULONG wave_id = dls_file.pool_cues[rgn.wave.ulTableIndex].ulOffset;
inst_region->WaveLink = rgn.wave;
inst_region->WaveLink.ulTableIndex = wave_id + dlid_wave;
/* The wave sample data will be taken from the region, if defined, otherwise from the wave itself. */
if (rgn.wave_sample.cbSize != 0) {
inst_region->WSMP = rgn.wave_sample;
if (rgn.wave_loops.size() > 0) MemCpyT(inst_region->WLOOP, &rgn.wave_loops.front(), rgn.wave_loops.size());
instrument = (char *)(inst_region + 1) - sizeof(DMUS_REGION::WLOOP) + sizeof(WLOOP) * rgn.wave_loops.size();
} else {
inst_region->WSMP = rgn.wave_sample;
if (dls_file.waves[wave_id].wave_loops.size() > 0) MemCpyT(inst_region->WLOOP, &dls_file.waves[wave_id].wave_loops.front(), dls_file.waves[wave_id].wave_loops.size());
instrument = (char *)(inst_region + 1) - sizeof(DMUS_REGION::WLOOP) + sizeof(WLOOP) * dls_file.waves[wave_id].wave_loops.size();
}
/* Write local articulator data. */
if (rgn.articulators.size() > 0) {
inst_region->ulRegionArtIdx = last_offset;
offset_table[last_offset++] = (char *)instrument - inst_base;
offset_table[last_offset++] = (char *)instrument + sizeof(DMUS_ARTICULATION2) - inst_base;
instrument = DownloadArticulationData(inst_region->ulRegionArtIdx, instrument, rgn.articulators);
} else {
inst_region->ulRegionArtIdx = 0;
}
assert((char *)instrument - inst_base <= (ptrdiff_t)inst_size);
/* Link to the next region unless this was the last one.*/
inst_region->ulNextRegionIdx = j < dls_file.instruments[i].regions.size() - 1 ? last_offset : 0;
}
_dls_downloads.push_back(dl_inst);
if (FAILED(download_port->Download(dl_inst))) {
download_port->Release();
return "Downloading DLS instrument failed";
}
}
download_port->Release();
}
return nullptr;
}
const char *MusicDriver_DMusic::Start(const StringList &parm)
{
/* Initialize COM */
if (FAILED(CoInitializeEx(nullptr, COINITBASE_MULTITHREADED))) return "COM initialization failed";
/* Create the DirectMusic object */
if (FAILED(CoCreateInstance(
CLSID_DirectMusic,
nullptr,
CLSCTX_INPROC,
IID_IDirectMusic,
(LPVOID*)&_music
))) {
return "Failed to create the music object";
}
/* Assign sound output device. */
if (FAILED(_music->SetDirectSound(nullptr, nullptr))) return "Can't set DirectSound interface";
/* MIDI events need to be send to the synth in time before their playback time
* has come. By default, we try send any events at least 50 ms before playback. */
_playback.preload_time = GetDriverParamInt(parm, "preload", 50);
int pIdx = GetDriverParamInt(parm, "port", -1);
if (_debug_driver_level > 0) {
/* Print all valid output ports. */
char desc[DMUS_MAX_DESCRIPTION];
DMUS_PORTCAPS caps;
MemSetT(&caps, 0);
caps.dwSize = sizeof(DMUS_PORTCAPS);
DEBUG(driver, 1, "Detected DirectMusic ports:");
for (int i = 0; _music->EnumPort(i, &caps) == S_OK; i++) {
if (caps.dwClass == DMUS_PC_OUTPUTCLASS) {
/* Description is UNICODE even for ANSI build. */
DEBUG(driver, 1, " %d: %s%s", i, convert_from_fs(caps.wszDescription, desc, lengthof(desc)), i == pIdx ? " (selected)" : "");
}
}
}
GUID guidPort;
if (pIdx >= 0) {
/* Check if the passed port is a valid port. */
DMUS_PORTCAPS caps;
MemSetT(&caps, 0);
caps.dwSize = sizeof(DMUS_PORTCAPS);
if (FAILED(_music->EnumPort(pIdx, &caps))) return "Supplied port parameter is not a valid port";
if (caps.dwClass != DMUS_PC_OUTPUTCLASS) return "Supplied port parameter is not an output port";
guidPort = caps.guidPort;
} else {
if (FAILED(_music->GetDefaultPort(&guidPort))) return "Can't query default music port";
}
/* Create new port. */
DMUS_PORTPARAMS params;
MemSetT(¶ms, 0);
params.dwSize = sizeof(DMUS_PORTPARAMS);
params.dwValidParams = DMUS_PORTPARAMS_CHANNELGROUPS;
params.dwChannelGroups = 1;
if (FAILED(_music->CreatePort(guidPort, ¶ms, &_port, nullptr))) return "Failed to create port";
/* Activate port. */
if (FAILED(_port->Activate(TRUE))) return "Failed to activate port";
/* Create playback buffer. */
DMUS_BUFFERDESC desc;
MemSetT(&desc, 0);
desc.dwSize = sizeof(DMUS_BUFFERDESC);
desc.guidBufferFormat = KSDATAFORMAT_SUBTYPE_DIRECTMUSIC;
desc.cbBuffer = 1024;
if (FAILED(_music->CreateMusicBuffer(&desc, &_buffer, nullptr))) return "Failed to create music buffer";
/* On soft-synths (e.g. the default DirectMusic one), we might need to load a wavetable set to get music. */
const char *dls = LoadDefaultDLSFile(GetDriverParam(parm, "dls"));
if (dls != nullptr) return dls;
/* Create playback thread and synchronization primitives. */
_thread_event = CreateEvent(nullptr, FALSE, FALSE, nullptr);
if (_thread_event == nullptr) return "Can't create thread shutdown event";
if (!StartNewThread(&_dmusic_thread, "ottd:dmusic", &MidiThreadProc)) return "Can't create MIDI output thread";
return nullptr;
}
MusicDriver_DMusic::~MusicDriver_DMusic()
{
this->Stop();
}
void MusicDriver_DMusic::Stop()
{
if (_dmusic_thread.joinable()) {
_playback.shutdown = true;
SetEvent(_thread_event);
_dmusic_thread.join();
}
/* Unloaded any instruments we loaded. */
if (_dls_downloads.size() > 0) {
IDirectMusicPortDownload *download_port = nullptr;
_port->QueryInterface(IID_IDirectMusicPortDownload, (LPVOID *)&download_port);
/* Instruments refer to waves. As the waves are at the beginning of the download list,
* do the unload from the back so that references are cleared properly. */
for (std::vector<IDirectMusicDownload *>::reverse_iterator i = _dls_downloads.rbegin(); download_port != nullptr && i != _dls_downloads.rend(); i++) {
download_port->Unload(*i);
(*i)->Release();
}
_dls_downloads.clear();
if (download_port != nullptr) download_port->Release();
}
if (_buffer != nullptr) {
_buffer->Release();
_buffer = nullptr;
}
if (_port != nullptr) {
_port->Activate(FALSE);
_port->Release();
_port = nullptr;
}
if (_music != nullptr) {
_music->Release();
_music = nullptr;
}
CloseHandle(_thread_event);
CoUninitialize();
}
void MusicDriver_DMusic::PlaySong(const MusicSongInfo &song)
{
std::lock_guard<std::mutex> lock(_thread_mutex);
if (!_playback.next_file.LoadSong(song)) return;
_playback.next_segment.start = song.override_start;
_playback.next_segment.end = song.override_end;
_playback.next_segment.loop = song.loop;
_playback.do_start = true;
SetEvent(_thread_event);
}
void MusicDriver_DMusic::StopSong()
{
_playback.do_stop = true;
SetEvent(_thread_event);
}
bool MusicDriver_DMusic::IsSongPlaying()
{
return _playback.playing || _playback.do_start;
}
void MusicDriver_DMusic::SetVolume(byte vol)
{
_playback.new_volume = vol;
}
|