/
gamemus.cpp
1544 lines (1402 loc) · 50 KB
/
gamemus.cpp
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
/**
* @file gamemus.cpp
* @brief Command-line interface to libgamemusic.
*
* Copyright (C) 2010-2015 Adam Nielsen <malvineous@shikadi.net>
*
* This program 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, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <thread>
#include <mutex>
#include <condition_variable>
#include <boost/program_options.hpp>
#include <camoto/gamemusic.hpp>
#include <camoto/util.hpp>
#include <camoto/stream_file.hpp>
#include <camoto/iostream_helpers.hpp>
#include <stdlib.h>
#include <iostream>
#include <fstream>
#include <queue>
#ifndef _MSC_VER
#include <config.h>
#endif
#ifdef USE_PORTAUDIO
// Must be after config.h
#include <portaudio.h>
#endif
#include "common-attributes.hpp"
namespace po = boost::program_options;
namespace gm = camoto::gamemusic;
using namespace camoto;
#define PROGNAME "gamemus"
/// Number of audio frames to generate at one time
#define FRAMES_TO_BUFFER 512
/// Number of channels in audio output
#define NUM_CHANNELS 2
/*** Return values ***/
// All is good
#define RET_OK 0
// Bad arguments (missing/invalid parameters)
#define RET_BADARGS 1
// Major error (couldn't open file, etc.)
#define RET_SHOWSTOPPER 2
// More info needed (-t auto didn't work, specify a type)
#define RET_BE_MORE_SPECIFIC 3
// One or more files failed, probably user error (file not found, etc.)
#define RET_NONCRITICAL_FAILURE 4
// Some files failed, but not in a common way (cut off write, disk full, etc.)
#define RET_UNCOMMON_FAILURE 5
/// @see libgamearchive/examples/gamearch.cpp
/// find_last_of() changed to find_first_of() here so equal signs can be put
/// into instrument names, e.g. for URLs
bool split(const std::string& in, char delim, std::string *out1, std::string *out2)
{
std::string::size_type iEqualPos = in.find_first_of(delim);
*out1 = in.substr(0, iEqualPos);
// Does the destination have a different filename?
bool bAltDest = iEqualPos != std::string::npos;
*out2 = bAltDest ? in.substr(iEqualPos + 1) : *out1;
return bAltDest;
}
/// Open a music file.
/**
* @param strFilename
* Filename of music or instrument file to open.
*
* @param typeArg
* Name of command line argument used to specify strType. Shown to user
* when strType is invalid to indicate which option was at fault.
*
* @param strType
* File type, empty string for autodetect.
*
* @param pManager
* Manager instance.
*
* @param bForceOpen
* True to force files to be opened, even if they are not of the indicated
* file format.
*
* @return Shared pointer to MusicReader instance.
*
* @throws int on failure (one of the RET_* values)
*/
int openMusicFile(const std::string& strFilename,
const char *typeArg, const std::string& strType, bool bForceOpen,
std::shared_ptr<gm::Music>* pMusicOut,
gm::MusicManager::handler_t* pMusicTypeOut)
{
stream::file content(strFilename, false);
gm::MusicManager::handler_t pMusicType;
if (strType.empty()) {
// Need to autodetect the file format.
for (const auto& i : gm::MusicManager::formats()) {
gm::MusicType::Certainty cert = i->isInstance(content);
switch (cert) {
case gm::MusicType::Certainty::DefinitelyNo:
// Don't print anything (TODO: Maybe unless verbose?)
break;
case gm::MusicType::Certainty::Unsure:
std::cout << "File could be: " << i->friendlyName()
<< " [" << i->code() << "]" << std::endl;
// If we haven't found a match already, use this one
if (!pMusicType) pMusicType = i;
break;
case gm::MusicType::Certainty::PossiblyYes:
std::cout << "File is likely to be: " << i->friendlyName()
<< " [" << i->code() << "]" << std::endl;
// Take this one as it's better than an uncertain match
pMusicType = i;
break;
case gm::MusicType::Certainty::DefinitelyYes:
std::cout << "File is definitely: " << i->friendlyName()
<< " [" << i->code() << "]" << std::endl;
pMusicType = i;
// Don't bother checking any other formats if we got a 100% match
goto finishTesting;
}
if (cert != gm::MusicType::Certainty::DefinitelyNo) {
// We got a possible match, see if it requires any suppdata
auto suppList = i->getRequiredSupps(content, strFilename);
if (suppList.size() > 0) {
// It has suppdata, see if it's present
std::cout << " * This format requires supplemental files..."
<< std::endl;
bool bSuppOK = true;
for (const auto& s : suppList) {
try {
stream::file test_presence(s.second, false);
} catch (const stream::open_error&) {
bSuppOK = false;
std::cout << " * Could not find/open " << s.second
<< ", format is probably not " << i->code() << std::endl;
break;
}
}
if (bSuppOK) {
// All supp files opened ok
std::cout << " * All supp files present, archive is likely "
<< i->code() << std::endl;
// Set this as the most likely format
pMusicType = i;
}
}
}
}
finishTesting:
if (!pMusicType) {
std::cerr << "Unable to automatically determine the file type. Use "
"the " << typeArg << " option to manually specify the file format."
<< std::endl;
return RET_BE_MORE_SPECIFIC;
}
} else {
auto pTestType = gm::MusicManager::byCode(strType);
if (!pTestType) {
std::cerr << "Unknown file type given to " << typeArg << ": " << strType
<< std::endl;
return RET_BADARGS;
}
pMusicType = pTestType;
}
assert(pMusicType != NULL);
// Check to see if the file is actually in this format
if (pMusicType->isInstance(content) == gm::MusicType::Certainty::DefinitelyNo) {
if (bForceOpen) {
std::cerr << "Warning: " << strFilename << " is not a "
<< pMusicType->friendlyName() << ", open forced." << std::endl;
} else {
std::cerr << "Invalid format: " << strFilename << " is not a "
<< pMusicType->friendlyName() << "\n"
<< "Use the -f option to try anyway." << std::endl;
return RET_BE_MORE_SPECIFIC;
}
}
// See if the format requires any supplemental files
auto suppList = pMusicType->getRequiredSupps(content, strFilename);
camoto::SuppData suppData;
for (const auto& s : suppList) {
try {
std::cout << "Opening supplemental file " << s.second << std::endl;
auto suppStream = std::make_unique<stream::file>(s.second, false);
suppData[s.first] = std::move(suppStream);
} catch (const stream::open_error& e) {
std::cerr << "Error opening supplemental file " << s.second
<< ": " << e.what() << std::endl;
return RET_SHOWSTOPPER;
}
}
// Open the file
try {
*pMusicOut = pMusicType->read(content, suppData);
assert(*pMusicOut);
} catch (const camoto::error& e) {
std::cerr << "Error opening music file: " << e.what() << std::endl;
return RET_SHOWSTOPPER;
}
*pMusicTypeOut = pMusicType;
return RET_OK;
}
// Event handler used to replace tempo events
class ReplaceTempo: virtual public gm::EventHandler
{
public:
ReplaceTempo(const gm::Tempo& newTempo)
: newTempo(newTempo)
{
}
virtual void endOfTrack(unsigned long delay) { };
virtual void endOfPattern(unsigned long delay) { };
virtual bool handleEvent(unsigned long delay, unsigned int trackIndex,
unsigned int patternIndex, const gm::TempoEvent *ev)
{
// Dodgy hack
gm::TempoEvent *ev2 = const_cast<gm::TempoEvent *>(ev);
ev2->tempo = this->newTempo;
std::cout << "Replaced tempo event" << std::endl;
return true;
}
virtual bool handleEvent(unsigned long delay, unsigned int trackIndex,
unsigned int patternIndex, const gm::NoteOnEvent *ev) { return true; };
virtual bool handleEvent(unsigned long delay, unsigned int trackIndex,
unsigned int patternIndex, const gm::NoteOffEvent *ev) { return true; };
virtual bool handleEvent(unsigned long delay, unsigned int trackIndex,
unsigned int patternIndex, const gm::EffectEvent *ev) { return true; };
virtual bool handleEvent(unsigned long delay, unsigned int trackIndex,
unsigned int patternIndex, const gm::GotoEvent *ev) { return true; };
virtual bool handleEvent(unsigned long delay, unsigned int trackIndex,
unsigned int patternIndex, const gm::ConfigurationEvent *ev) { return true; };
private:
gm::Tempo newTempo;
};
#ifdef USE_PORTAUDIO
struct PositionHistory {
PaTime time;
gm::Playback::Position pos;
};
struct PBCallback
{
gm::Playback *playback;
PositionHistory position;
gm::Playback::Position lastPos;
PaTime waitUntil; // stream time the main thread is waiting for
std::mutex mut;
std::condition_variable wait;
};
static int paCallback(const void *inputBuffer, void *outputBuffer,
unsigned long framesPerBuffer, const PaStreamCallbackTimeInfo *timeInfo,
PaStreamCallbackFlags statusFlags, void *userData)
{
PBCallback *pbcb = (PBCallback *)userData;
memset(outputBuffer, 0, framesPerBuffer * NUM_CHANNELS * 2);
{
std::lock_guard<std::mutex> lock(pbcb->mut);
pbcb->playback->mix((int16_t *)outputBuffer, framesPerBuffer * 2, &pbcb->position.pos);
pbcb->position.time = timeInfo->outputBufferDacTime;
}
if (
(pbcb->position.pos != pbcb->lastPos) ||
(pbcb->waitUntil <= timeInfo->currentTime) ||
(pbcb->position.pos.end)
) {
pbcb->lastPos = pbcb->position.pos;
// Notify anyone waiting that the position has updated
pbcb->wait.notify_all();
}
return paContinue;
}
#endif // USE_PORTAUDIO
/// Play the given song.
/**
* @param music
* Song to play.
*
* @param bankMIDI
* Patch bank to use for MIDI notes.
*
* @param loopCount
* Number of times to play the song. 1=once, 2=twice (loop once), 0=loop
* forever. If 0, this function never returns. Note these values are
* different to those given to the --loop parameter.
*
* @param extraTime
* Number of seconds to linger after song finishes, to let notes fade out.
*/
int play(std::shared_ptr<gm::Music> music,
std::shared_ptr<const gm::PatchBank> bankMIDI, unsigned int loopCount,
unsigned int extraTime)
{
#ifdef USE_PORTAUDIO
// Init PA
PaError err = Pa_Initialize();
if (err != paNoError) {
std::cerr << "Unable to initialise PortAudio. Pa_Initialize() failed: "
<< Pa_GetErrorText(err) << std::endl;
return RET_SHOWSTOPPER;
}
// Open audio device
PaStreamParameters op;
op.device = Pa_GetDefaultOutputDevice();
if (op.device == paNoDevice) {
std::cerr << "No available audio devices. Pa_GetDefaultOutputDevice() "
"returned paNoDevice." << std::endl;
Pa_Terminate();
return RET_SHOWSTOPPER;
}
op.channelCount = NUM_CHANNELS;
op.sampleFormat = paInt16; // paFloat32
op.suggestedLatency = 1;//Pa_GetDeviceInfo(op.device)->defaultLowOutputLatency;
op.hostApiSpecificStreamInfo = NULL;
unsigned int sampleRate = 48000;
gm::Playback playback(sampleRate, NUM_CHANNELS, 16);
playback.setBankMIDI(bankMIDI);
playback.setSong(music);
playback.setLoopCount(loopCount);
PBCallback pbcb;
pbcb.playback = &playback;
pbcb.position.pos.end = false;
PaStream *stream;
err = Pa_OpenStream(&stream, NULL, &op, sampleRate,
paFramesPerBufferUnspecified, paClipOff, paCallback, &pbcb);
if (err != paNoError) {
std::cerr << "Unable to open audio stream. Pa_OpenStream() failed: "
<< Pa_GetErrorText(err) << std::endl;
Pa_Terminate();
return RET_SHOWSTOPPER;
}
err = Pa_StartStream(stream);
pbcb.waitUntil = 0;
if (err != paNoError) {
std::cerr << "Unable to start audio stream. Pa_StartStream() failed: "
<< Pa_GetErrorText(err) << std::endl;
Pa_CloseStream(stream);
Pa_Terminate();
return RET_SHOWSTOPPER;
}
pbcb.waitUntil = Pa_GetStreamTime(stream);
const PaStreamInfo *info = Pa_GetStreamInfo(stream);
if (!info) {
std::cerr << "Unable to get stream parameters. Pa_GetStreamInfo() failed."
<< std::endl;
Pa_CloseStream(stream);
Pa_Terminate();
return RET_SHOWSTOPPER;
}
std::cout << "Adjusting for output latency: " << info->outputLatency << " sec\n";
auto msTotal = playback.getLength();
auto min = msTotal / 60000;
auto sec = (msTotal % 60000) / 1000;
auto ms = (msTotal % 1000) / 100;
std::cout << "Calculated song length: " << min << ":" << std::setw(2)
<< std::setfill('0') << sec << "." << ms << " (" << msTotal << " ms)"
<< std::endl;
std::queue<PositionHistory> queuePos;
gm::Playback::Position lastPos;
gm::Playback::Position audiblePos, lastAudiblePos;
audiblePos.end = false;
PaTime lastTime = 0;
{
std::unique_lock<std::mutex> lock(pbcb.mut);
while (!audiblePos.end) {
//if (!pbcb.position.pos.end)
pbcb.wait.wait(lock);
// The values returned by PortAudio don't include the output latency
// so we have to add that now to make this position change slightly
// further in the future.
// 2015-11-26: Apparently this is no longer needed?
//pbcb.position.time += info->outputLatency;
lastTime = pbcb.position.time;
// See if the position has changed
if (pbcb.position.pos != lastPos) {
// It has, so store it and the time
queuePos.push(pbcb.position);
lastPos = pbcb.position.pos;
}
// Check to see whether the oldest pos has played yet
while (!queuePos.empty()) {
PositionHistory& nextH = queuePos.front();
if (nextH.time <= Pa_GetStreamTime(stream)) {
// This pos has been played now
audiblePos = nextH.pos;
queuePos.pop();
} else {
// The next event hasn't happened yet, leave it for later
pbcb.waitUntil = nextH.time;
break;
}
}
if (audiblePos != lastAudiblePos) {
// The position being played out of the speakers has just changed
long pattern = -1;
if (audiblePos.order < music->patternOrder.size()) {
pattern = music->patternOrder[audiblePos.order];
}
unsigned int beat = (audiblePos.row / audiblePos.tempo.ticksPerBeat)
% audiblePos.tempo.beatsPerBar;
std::cout
<< std::setfill(' ')
<< "Loop: " << audiblePos.loop
<< " Order: " << std::setw(2) << audiblePos.order
<< " Pattern: " << std::setw(2) << pattern
<< " Row: " << std::setw(2) << audiblePos.row
<< " Beat: " << beat
<< " \r" << std::flush;
lastAudiblePos = audiblePos;
}
}
if (extraTime) {
PaTime endTime = lastTime + extraTime;
do {
pbcb.wait.wait(lock);
} while (pbcb.position.time < endTime);
}
}
std::cout << "\n";
Pa_StopStream(stream);
Pa_CloseStream(stream);
Pa_Terminate();
return RET_OK;
#else
std::cerr << "PortAudio was not available at compile time, playback is "
"unavailable." << std::endl;
return RET_BADARGS;
#endif
}
/// Render the given song to a .wav file.
/**
* @param wavFilename
* Filename and optional path of the output file.
*
* @param music
* Song to play.
*
* @param bankMIDI
* Patch bank to use for MIDI notes.
*
* @param loopCount
* Number of times to play the song. 1=once, 2=twice (loop once), 0=loop
* forever. If 0, this function never returns. Note these values are
* different to those given to the --loop parameter.
*
* @param extraTime
* Number of seconds to linger after song finishes, to let notes fade out.
*/
int render(stream::output& wav, std::shared_ptr<gm::Music> music,
std::shared_ptr<gm::PatchBank> bankMIDI, unsigned int loopCount,
unsigned int extraTime)
{
if (loopCount == 0) {
std::cerr << "Can't loop forever when writing to .wav or you will run out "
"of disk space!" << std::endl;
return RET_BADARGS;
}
unsigned int numChannels = NUM_CHANNELS;
unsigned int bitDepth = 16;
unsigned int sampleRate = 48000;
gm::Playback playback(sampleRate, numChannels, bitDepth);
playback.setBankMIDI(bankMIDI);
playback.setSong(music);
playback.setLoopCount(loopCount);
// Make room for the header, will rewrite later
#define WAVE_FMT_SIZE (2+2+4+4+2+2)
#define WAVE_HEADER_SIZE (4+4+4+4+4+WAVE_FMT_SIZE+4+4)
wav
<< "RIFF"
<< u32le(0) // overwritten later
<< "WAVEfmt "
<< u32le(WAVE_FMT_SIZE)
<< u16le(1) // PCM
<< u16le(numChannels)
<< u32le(sampleRate)
<< u32le(sampleRate * numChannels * bitDepth / 8)
<< u16le(numChannels * bitDepth / 8)
<< u16le(bitDepth)
<< "data"
<< u32le(0) // overwritten later
;
const unsigned long lenBuffer = FRAMES_TO_BUFFER * NUM_CHANNELS;
std::vector<int16_t> output(lenBuffer);
const unsigned long lenBufferBytes = lenBuffer * 2;
std::cout << "Writing WAV at " << sampleRate << "Hz, " << bitDepth << "-bit, "
<< (numChannels == 1 ? "mono" : "stereo")
<< "\nExtra time: " << extraTime << " seconds, loop: ";
if (loopCount == 1) std::cout << "off"; else std::cout << loopCount - 1;
std::cout << std::endl;
gm::Playback::Position pos, lastPos;
lastPos.end = true;
pos.end = false;
unsigned int numOrders = music->patternOrder.size();
while (!pos.end) {
memset(output.data(), 0, lenBufferBytes);
playback.mix(output.data(), lenBuffer, &pos);
// Make sure samples are little-endian
for (unsigned int i = 0; i < lenBuffer; i++) output[i] = htole16(output[i]);
wav.write((uint8_t *)output.data(), lenBuffer * sizeof(int16_t));
if (pos != lastPos) {
long pattern = -1;
if (pos.order < numOrders) {
pattern = music->patternOrder[pos.order];
}
unsigned int loopLength = numOrders - (music->loopDest == -1 ? 0 : music->loopDest);
unsigned int progress = (
(pos.loop * loopLength + pos.order)
* music->ticksPerTrack + pos.row
) * 100
/ (((loopCount - 1) * loopLength + numOrders) * music->ticksPerTrack);
std::cout
<< std::setfill(' ')
<< "Loop: " << pos.loop
<< " Order: " << std::setw(2) << pos.order
<< " Pattern: " << std::setw(2) << pattern
<< " Row: " << std::setw(2) << pos.row
<< " Progress: " << progress
<< "% \r" << std::flush;
lastPos = pos;
}
}
if (extraTime) {
unsigned long extraSamples = extraTime * sampleRate * numChannels;
while (extraSamples >= lenBuffer) {
memset(output.data(), 0, lenBufferBytes);
playback.mix(output.data(), lenBuffer, &pos);
extraSamples -= lenBuffer;
// Make sure samples are little-endian
for (unsigned int i = 0; i < lenBuffer; i++) output[i] = htole16(output[i]);
wav.write((uint8_t *)output.data(), lenBuffer * sizeof(int16_t));
}
}
std::cout << "\n";
stream::pos lenTotal = wav.tellp();
wav.seekp(4, stream::start);
wav << u32le(lenTotal - 8);
wav.seekp(WAVE_HEADER_SIZE - 4, stream::start);
wav << u32le(lenTotal - WAVE_HEADER_SIZE);
wav.flush();
return RET_OK;
}
/// Convert the track info struct into human-readable text
std::string getTrackChannelText(const gm::TrackInfo& ti)
{
std::string text;
switch (ti.channelType) {
case gm::TrackInfo::ChannelType::Unused:
text = "Unused";
break;
case gm::TrackInfo::ChannelType::Any:
text = "Any";
break;
case gm::TrackInfo::ChannelType::OPL:
text = createString("OPL " << ti.channelIndex << " [chan " << ti.channelIndex % 9 << " @ chip " << ti.channelIndex / 9 << "]");
break;
case gm::TrackInfo::ChannelType::OPLPerc:
text = "OPL percussive ";
switch (ti.channelIndex) {
case 4: text += "bass drum"; break;
case 3: text += "snare"; break;
case 2: text += "tomtom"; break;
case 1: text += "top cymbal"; break;
case 0: text += "hi-hat"; break;
default:
text += createString("- channelIndex " << ti.channelIndex
<< " out of range!");
break;
}
break;
case gm::TrackInfo::ChannelType::MIDI:
text = createString("MIDI " << ti.channelIndex);
break;
case gm::TrackInfo::ChannelType::PCM:
text = createString("PCM " << ti.channelIndex);
break;
}
return text;
}
int main(int iArgC, char *cArgV[])
{
#ifdef __GLIBCXX__
// Set a better exception handler
std::set_terminate(__gnu_cxx::__verbose_terminate_handler);
#endif
// Disable stdin/printf/etc. sync for a speed boost
std::ios_base::sync_with_stdio(false);
// Declare the supported options.
po::options_description poActions("Actions");
poActions.add_options()
("list-events,v",
"list all events in the song")
("list-instruments,i",
"list channel map and all instruments in the song")
("metadata,m",
"list metadata tags (title, etc.)")
("remap-tracks,k", po::value<std::string>(),
"change the target channel for each track")
("convert,c", po::value<std::string>(),
"convert the song to another file format")
("start-at", po::value<int>(),
"drop notes from the start until this number of ticks")
("stop-at", po::value<int>(),
"drop all events after this number of ticks")
("newinst,n", po::value<std::string>(),
"override the instrument bank used by subsequent conversions (-c)")
("rename-instrument,e", po::value<std::string>(),
"rename the given instrument (-e index=name)")
("play,p",
"play the song on the default audio device")
("tempo", po::value<std::string>(),
"change the speed of the song")
("wav,w", po::value<std::string>(),
"render the song to a .wav file with the given filename")
("repeat-instruments,r", po::value<int>(),
"repeat the instrument bank until there are this many valid instruments")
("tag-title", po::value<std::string>(),
"set the title tag for the next output file, blank to remove tag")
("tag-artist", po::value<std::string>(),
"set the artist tag for the next output file, blank to remove tag")
("tag-comment", po::value<std::string>(),
"set the comment tag for the next output file, blank to remove tag")
;
po::options_description poOptions("Options");
poOptions.add_options()
("type,t", po::value<std::string>(),
"specify the music file format (default is autodetect)")
("script,s",
"format output suitable for script parsing")
("force,f",
"force open even if the file is not in the given format")
("list-types",
"list available input/output file formats")
("no-pitchbends,o",
"don't use pitchbends with -c")
("force-opl3,3",
"force OPL3 mode (18 channels) with -c")
("force-opl2,2",
"force OPL2 mode (11 channels) with -c")
("loop,l", po::value<int>(),
"repeat the song (-1=loop forever, 0=no loop, 1=loop once) [default=1]")
("extra-time,x", po::value<int>(),
"number of seconds to linger after song finishes to allow notes to fade "
"out [default=2]")
("midibank,b", po::value<std::string>(),
"patch bank to use for MIDI instruments with --play and --wav "
"[default=none, MIDI is silent]")
;
po::options_description poHidden("Hidden parameters");
poHidden.add_options()
("music", "music file to manipulate")
("help", "produce help message")
;
po::options_description poVisible("");
poVisible.add(poActions).add(poOptions);
po::options_description poComplete("Parameters");
poComplete.add(poActions).add(poOptions).add(poHidden);
po::variables_map mpArgs;
std::string strFilename;
std::string strType;
bool bScript = false; // show output suitable for script parsing?
bool bForceOpen = false; // open anyway even if not in given format?
bool bUsePitchbends = true; // pass pitchbend events with -c
bool bForceOPL2 = false; // force OPL2 mode?
bool bForceOPL3 = false; // force OPL3 mode?
int userLoop = 1; // repeat once by default
int extraTime = 2; // two seconds extra by default
std::shared_ptr<gm::PatchBank> bankMIDI; // instruments to use for MIDI notes
try {
po::parsed_options pa = po::parse_command_line(iArgC, cArgV, poComplete);
// Parse the global command line options
for (std::vector<po::option>::iterator i = pa.options.begin(); i != pa.options.end(); i++) {
if (i->string_key.empty()) {
// If we've already got a filename, complain that a second one
// was given (probably a typo.)
if (!strFilename.empty()) {
std::cerr << "Error: unexpected extra parameter (multiple "
"filenames given?!)" << std::endl;
return RET_BADARGS;
}
assert(i->value.size() > 0); // can't have no values with no name!
strFilename = i->value[0];
} else if (i->string_key.compare("help") == 0) {
std::cout <<
"Copyright (C) 2010-2015 Adam Nielsen <malvineous@shikadi.net>\n"
"This program comes with ABSOLUTELY NO WARRANTY. This is free software,\n"
"and you are welcome to change and redistribute it under certain conditions;\n"
"see <http://www.gnu.org/licenses/> for details.\n"
"\n"
"Utility to manipulate music files used by games.\n"
"Build date " __DATE__ " " __TIME__ << "\n"
"\n"
"Usage: gamemus [options] <infile> [actions...]\n" << poVisible << "\n"
"--convert requires a filetype prefix, e.g. raw-rdos:out.raw. Also works\n"
"with --newinst if the file type cannot be autodetected."
<< std::endl;
return RET_OK;
} else if (i->string_key.compare("list-types") == 0) {
for (const auto& i : gm::MusicManager::formats()) {
std::string code = i->code();
std::cout << code;
int len = code.length();
if (len < 20) std::cout << std::string(20 - len, ' ');
std::string desc = i->friendlyName();
std::cout << ' ' << desc;
std::vector<std::string> exts = i->fileExtensions();
if (exts.size() > 0) {
len = desc.length();
if (len < 40) std::cout << std::string(40-len, ' ');
std::cout << " [";
std::string sep;
for (std::vector<std::string>::iterator i = exts.begin();
i != exts.end();
i++
) {
std::cout << sep << "*." << *i;
if (sep.empty()) sep = "; ";
}
std::cout << ']';
}
std::cout << '\n';
}
return RET_OK;
} else if (
(i->string_key.compare("t") == 0) ||
(i->string_key.compare("type") == 0)
) {
if (i->value.size() == 0) {
std::cerr << PROGNAME ": --type (-t) requires a parameter."
<< std::endl;
return RET_BADARGS;
}
strType = i->value[0];
} else if (
(i->string_key.compare("s") == 0) ||
(i->string_key.compare("script") == 0)
) {
bScript = true;
} else if (
(i->string_key.compare("f") == 0) ||
(i->string_key.compare("force") == 0)
) {
bForceOpen = true;
} else if (
(i->string_key.compare("o") == 0) ||
(i->string_key.compare("no-pitchbends") == 0)
) {
bUsePitchbends = false;
} else if (
(i->string_key.compare("3") == 0) ||
(i->string_key.compare("force-opl3") == 0)
) {
bForceOPL3 = true;
} else if (
(i->string_key.compare("2") == 0) ||
(i->string_key.compare("force-opl2") == 0)
) {
bForceOPL2 = true;
} else if (
(i->string_key.compare("l") == 0) ||
(i->string_key.compare("loop") == 0)
) {
userLoop = strtod(i->value[0].c_str(), NULL);
} else if (
(i->string_key.compare("x") == 0) ||
(i->string_key.compare("extra-time") == 0)
) {
extraTime = strtod(i->value[0].c_str(), NULL);
} else if (
(i->string_key.compare("b") == 0) ||
(i->string_key.compare("midibank") == 0)
) {
std::string strInstFile;
std::string strInstType;
if (!split(i->value[0], ':', &strInstType, &strInstFile)) {
strInstType.clear(); // no type given, autodetect
}
gm::MusicManager::handler_t pInstType;
std::shared_ptr<gm::Music> pInst;
try {
auto ret = openMusicFile(strInstFile, "-b/--midibank", strInstType,
bForceOpen, &pInst, &pInstType);
if (ret != RET_OK) return ret;
} catch (stream::open_error& e) {
std::cerr << "Error opening instrument bank " << strFilename
<< ": " << e.what() << std::endl;
return RET_SHOWSTOPPER;
}
if (!pInst->patches) {
std::cerr << "MIDI bank given with -b/--midibank has no instruments!"
<< std::endl;
return RET_BADARGS;
}
bankMIDI = pInst->patches;
}
}
if ((bForceOPL2 == true) && (bForceOPL3 == true)) {
std::cerr << "Error: can't force OPL2 and OPL3 at the same time!" << std::endl;
return RET_BADARGS;
}
if (strFilename.empty()) {
std::cerr << "Error: no filename given. Use --help for help." << std::endl;
return RET_BADARGS;
}
if (!bScript) std::cout << "Opening " << strFilename << " as type "
<< (strType.empty() ? "<autodetect>" : strType) << std::endl;
gm::MusicManager::handler_t pMusicType;
std::shared_ptr<gm::Music> pMusic;
try {
int ret = openMusicFile(strFilename, "-t/--type", strType, bForceOpen,
&pMusic, &pMusicType);
if (ret != RET_OK) return ret;
} catch (stream::open_error& e) {
std::cerr << "Error opening " << strFilename << ": " << e.what()
<< std::endl;
return RET_SHOWSTOPPER;
}
if (bForceOPL2 || bForceOPL3) {
unsigned int patternIndex = 0;
// For each pattern
for (auto& pp : pMusic->patterns) {
unsigned int trackIndex = 0;
// For each track
for (auto& pt : pp) {
// For each event in the track
for (auto ev = pt.begin(); ev != pt.end(); ev++) {
auto& te = *ev;
gm::ConfigurationEvent *cev = dynamic_cast<gm::ConfigurationEvent *>(te.event.get());
if (cev) {
switch (cev->configType) {
case gm::ConfigurationEvent::Type::EmptyEvent:
// Nothing to do
break;
case gm::ConfigurationEvent::Type::EnableOPL3:
// Got an OPL3 mode change event, nullify it. This is easier
// than deleting it because we don't have to handle merging
// the delay in with a following event (or creating a None
// event anyway if there is no event following this one.)
cev->value = bForceOPL3 ? 1 : 0;
break;
case gm::ConfigurationEvent::Type::EnableDeepTremolo: {
if (bForceOPL3) {
// Duplicate this event for the other chip
gm::TrackEvent te2;
te2.delay = 0;
auto ev2 = std::make_shared<gm::ConfigurationEvent>(*cev);
te2.event = ev2;
ev2->value |= 2; // "|=2" == chip index 1
ev = pt.insert(ev+1, te2);
}
break;
}
case gm::ConfigurationEvent::Type::EnableDeepVibrato: {
if (bForceOPL3) {
// Duplicate this event for the other chip
gm::TrackEvent te2;
te2.delay = 0;
auto ev2 = std::make_shared<gm::ConfigurationEvent>(*cev);
te2.event = ev2;
ev2->value |= 2; // "|=2" == chip index 1
ev = pt.insert(ev+1, te2);
}
break;
}
case gm::ConfigurationEvent::Type::EnableRhythm:
// Not sure how to deal with this yet
break;
case gm::ConfigurationEvent::Type::EnableWaveSel:
// Always enabled on OPL3, no need to do anything
break;
}
}
} // end of track
trackIndex++;
} // end of pattern
patternIndex++;
} // end of song
// Insert an OPL 2/3 switch event at the start of the first track
// This isn't perfect (the first pattern may not play first) but it'll
// do for the moment.
// @todo: Find first order number and put it in that pattern instead.
// @todo: But only if that pattern doesn't already have an OPL event at the start
if (pMusic->patterns.size() > 0) {
auto& pattern = pMusic->patterns.at(0);
if (pattern.size() > 0) {
auto& track = pattern.at(0);
gm::TrackEvent te2;
te2.delay = 0;
auto ev2 = std::make_shared<gm::ConfigurationEvent>();
te2.event = ev2;
ev2->configType = gm::ConfigurationEvent::Type::EnableOPL3;
ev2->value = bForceOPL3 ? 1 : 0;
track.insert(track.begin(), te2);
}
}