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
|
/* Cabal - Legacy Game Implementations
*
* Cabal is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* 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 2
* 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#include "backends/audiocd/win32/win32-audiocd.h"
#include "audio/audiostream.h"
#include "backends/audiocd/default/default-audiocd.h"
#include "common/array.h"
#include "common/config-manager.h"
#include "common/debug.h"
#include "common/mutex.h"
#include "common/queue.h"
#include "common/str.h"
#include "common/timer.h"
#define WIN32_LEAN_AND_MEAN
#include <windows.h>
#ifdef _MSC_VER
#include <winioctl.h>
#include <ntddcdrm.h>
#else
#include <ddk/ntddcdrm.h>
#endif
enum {
kLeadoutTrack = 0xAA
};
enum {
kBytesPerFrame = 2352,
kSamplesPerFrame = kBytesPerFrame / 2
};
enum {
kSecondsPerMinute = 60,
kFramesPerSecond = 75
};
enum {
// The CD-ROM pre-gap is 2s
kPreGapFrames = kFramesPerSecond * 2
};
enum {
// Keep about a second's worth of audio in the buffer
kBufferThreshold = kFramesPerSecond
};
static int getFrameCount(const TRACK_DATA &data) {
int time = data.Address[1];
time *= kSecondsPerMinute;
time += data.Address[2];
time *= kFramesPerSecond;
time += data.Address[3];
return time;
}
class Win32AudioCDStream : public Audio::SeekableAudioStream {
public:
Win32AudioCDStream(HANDLE handle, const TRACK_DATA &startEntry, const TRACK_DATA &endEntry);
~Win32AudioCDStream();
int readBuffer(int16 *buffer, const int numSamples);
bool isStereo() const { return true; }
int getRate() const { return 44100; }
bool endOfData() const;
bool seek(const Audio::Timestamp &where);
Audio::Timestamp getLength() const;
private:
HANDLE _driveHandle;
const TRACK_DATA &_startEntry, &_endEntry;
int16 _buffer[kSamplesPerFrame];
int _frame;
uint _bufferPos;
Common::Queue<int16 *> _bufferQueue;
int _bufferFrame;
Common::Mutex _mutex;
bool readNextFrame();
static void timerProc(void *refCon);
void onTimer();
void emptyQueue();
void startTimer();
void stopTimer();
};
Win32AudioCDStream::Win32AudioCDStream(HANDLE handle, const TRACK_DATA &startEntry, const TRACK_DATA &endEntry) :
_driveHandle(handle), _startEntry(startEntry), _endEntry(endEntry), _buffer(), _frame(0), _bufferPos(kSamplesPerFrame), _bufferFrame(0) {
startTimer();
}
Win32AudioCDStream::~Win32AudioCDStream() {
stopTimer();
emptyQueue();
}
int Win32AudioCDStream::readBuffer(int16 *buffer, const int numSamples) {
int samples = 0;
// See if any data is left first
while (_bufferPos < kSamplesPerFrame && samples < numSamples)
buffer[samples++] = _buffer[_bufferPos++];
// Bail out if done
if (endOfData())
return samples;
while (samples < numSamples && !endOfData()) {
if (!readNextFrame())
return samples;
// Copy the samples over
for (_bufferPos = 0; _bufferPos < kSamplesPerFrame && samples < numSamples; )
buffer[samples++] = _buffer[_bufferPos++];
}
return samples;
}
bool Win32AudioCDStream::readNextFrame() {
// Fetch a frame from the queue
int16 *buffer;
{
Common::StackLock lock(_mutex);
// Nothing we can do if it's empty
if (_bufferQueue.empty())
return false;
buffer = _bufferQueue.pop();
}
memcpy(_buffer, buffer, kSamplesPerFrame * 2);
delete[] buffer;
_frame++;
return true;
}
bool Win32AudioCDStream::endOfData() const {
return getFrameCount(_startEntry) + _frame >= getFrameCount(_endEntry) && _bufferPos == kSamplesPerFrame;
}
bool Win32AudioCDStream::seek(const Audio::Timestamp &where) {
// Stop the timer
stopTimer();
// Clear anything out of the queue
emptyQueue();
// Convert to the frame number
// Really not much else needed
_bufferPos = kSamplesPerFrame;
_frame = where.convertToFramerate(kFramesPerSecond).totalNumberOfFrames();
_bufferFrame = _frame;
// Start the timer again
startTimer();
return true;
}
Audio::Timestamp Win32AudioCDStream::getLength() const {
return Audio::Timestamp(0, getFrameCount(_endEntry) - getFrameCount(_startEntry), 75);
}
void Win32AudioCDStream::timerProc(void *refCon) {
static_cast<Win32AudioCDStream *>(refCon)->onTimer();
}
void Win32AudioCDStream::onTimer() {
// The goal here is to do as much work in this timer instead
// of doing it in the readBuffer() call, which is the mixer.
// If we're done, bail.
if (getFrameCount(_startEntry) + _bufferFrame >= getFrameCount(_endEntry))
return;
// Get a quick count of the number of items in the queue
// We don't care that much; we only need a quick estimate
_mutex.lock();
uint32 queueCount = _bufferQueue.size();
_mutex.unlock();
// If we have enough audio buffered, bail out
if (queueCount >= kBufferThreshold)
return;
while (queueCount < kBufferThreshold && getFrameCount(_startEntry) + _bufferFrame < getFrameCount(_endEntry)) {
int16 *buffer = new int16[kSamplesPerFrame];
// Figure out the MSF of the frame we're looking for
int frame = _bufferFrame + getFrameCount(_startEntry);
// Request to read that frame
RAW_READ_INFO readAudio;
memset(&readAudio, 0, sizeof(readAudio));
readAudio.DiskOffset.QuadPart = (frame - kPreGapFrames) * 2048;
readAudio.SectorCount = 1;
readAudio.TrackMode = CDDA;
DWORD bytesReturned;
bool result = DeviceIoControl(
_driveHandle,
IOCTL_CDROM_RAW_READ,
&readAudio,
sizeof(readAudio),
buffer,
kBytesPerFrame,
&bytesReturned,
NULL);
if (!result) {
warning("Failed to retrieve CD sector %d: %d", frame, (int)GetLastError());
_bufferFrame = getFrameCount(_endEntry) - getFrameCount(_startEntry);
return;
}
_bufferFrame++;
// Now push the buffer onto the queue
Common::StackLock lock(_mutex);
_bufferQueue.push(buffer);
queueCount = _bufferQueue.size();
}
}
void Win32AudioCDStream::startTimer() {
g_system->getTimerManager()->installTimerProc(timerProc, 10 * 1000, this, "Win32AudioCDStream");
}
void Win32AudioCDStream::stopTimer() {
g_system->getTimerManager()->removeTimerProc(timerProc);
}
void Win32AudioCDStream::emptyQueue() {
while (!_bufferQueue.empty())
delete[] _bufferQueue.pop();
}
class Win32AudioCDManager : public DefaultAudioCDManager {
public:
Win32AudioCDManager();
~Win32AudioCDManager();
bool open();
void close();
void play(int track, int numLoops, int startFrame, int duration, bool onlyEmulate = false);
protected:
bool openCD(int drive);
bool openCD(const Common::String &drive);
private:
bool loadTOC();
typedef Common::Array<char> DriveList;
DriveList detectDrives();
bool tryAddDrive(char drive, DriveList &drives);
HANDLE _driveHandle;
int _firstTrack, _lastTrack;
Common::Array<TRACK_DATA> _tocEntries;
};
Win32AudioCDManager::Win32AudioCDManager() {
_driveHandle = INVALID_HANDLE_VALUE;
_firstTrack = _lastTrack = 0;
}
Win32AudioCDManager::~Win32AudioCDManager() {
close();
}
bool Win32AudioCDManager::open() {
close();
if (openRealCD())
return true;
return DefaultAudioCDManager::open();
}
bool Win32AudioCDManager::openCD(int drive) {
// Fetch the drive list
DriveList drives = detectDrives();
if (drive >= (int)drives.size())
return false;
debug(1, "Opening CD drive %c:\\", drives[drive]);
// Construct the drive path and try to open it
Common::String drivePath = Common::String::format("\\\\.\\%c:", drives[drive]);
_driveHandle = CreateFileA(drivePath.c_str(), GENERIC_READ, FILE_SHARE_READ | FILE_SHARE_WRITE, 0, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, 0);
if (_driveHandle == INVALID_HANDLE_VALUE) {
warning("Failed to open drive %c:\\, error %d", drives[drive], (int)GetLastError());
return false;
}
if (!loadTOC()) {
close();
return false;
}
return true;
}
bool Win32AudioCDManager::openCD(const Common::String &drive) {
// Just some bounds checking
if (drive.empty() || drive.size() > 3)
return false;
if (!Common::isAlpha(drive[0]) || drive[1] != ':')
return false;
if (drive[2] != 0 && drive[2] != '\\')
return false;
DriveList drives;
if (!tryAddDrive(toupper(drive[0]), drives))
return false;
// Construct the drive path and try to open it
Common::String drivePath = Common::String::format("\\\\.\\%c:", drives[0]);
_driveHandle = CreateFileA(drivePath.c_str(), GENERIC_READ, FILE_SHARE_READ | FILE_SHARE_WRITE, 0, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, 0);
if (_driveHandle == INVALID_HANDLE_VALUE) {
warning("Failed to open drive %c:\\, error %d", drives[0], (int)GetLastError());
return false;
}
if (!loadTOC()) {
close();
return false;
}
return true;
}
void Win32AudioCDManager::close() {
DefaultAudioCDManager::close();
if (_driveHandle != INVALID_HANDLE_VALUE) {
CloseHandle(_driveHandle);
_driveHandle = INVALID_HANDLE_VALUE;
}
_firstTrack = _lastTrack = 0;
_tocEntries.clear();
}
bool Win32AudioCDManager::play(int track, int numLoops, int startFrame, int duration, bool onlyEmulate) {
// Prefer emulation
if (DefaultAudioCDManager::play(track, numLoops, startFrame, duration, onlyEmulate))
return true;
// If we're set to only emulate, or have no CD drive, return here
if (onlyEmulate || _driveHandle == INVALID_HANDLE_VALUE)
return false;
// HACK: For now, just assume that track number is right
// That only works because ScummVM uses the wrong track number anyway
if (track >= (int)_tocEntries.size() - 1) {
warning("No such track %d", track);
return false;
}
// Bail if the track isn't an audio track
if ((_tocEntries[track].Control & 0x04) != 0) {
warning("Track %d is not audio", track);
return false;
}
// Create the AudioStream and play it
debug(1, "Playing CD track %d", track);
Audio::SeekableAudioStream *audioStream = new Win32AudioCDStream(_driveHandle, _tocEntries[track], _tocEntries[track + 1]);
Audio::Timestamp start = Audio::Timestamp(0, startFrame, 75);
Audio::Timestamp end = (duration == 0) ? audioStream->getLength() : Audio::Timestamp(0, startFrame + duration, 75);
// Fake emulation since we're really playing an AudioStream
_emulating = true;
_mixer->playStream(
Audio::Mixer::kMusicSoundType,
&_handle,
Audio::makeLoopingAudioStream(audioStream, start, end, (numLoops < 1) ? numLoops + 1 : numLoops),
-1,
_cd.volume,
_cd.balance,
DisposeAfterUse::YES,
true);
return true;
}
bool Win32AudioCDManager::loadTOC() {
CDROM_READ_TOC_EX tocRequest;
memset(&tocRequest, 0, sizeof(tocRequest));
tocRequest.Format = CDROM_READ_TOC_EX_FORMAT_TOC;
tocRequest.Msf = 1;
tocRequest.SessionTrack = 0;
DWORD bytesReturned;
CDROM_TOC tocData;
bool result = DeviceIoControl(
_driveHandle,
IOCTL_CDROM_READ_TOC_EX,
&tocRequest,
sizeof(tocRequest),
&tocData,
sizeof(tocData),
&bytesReturned,
NULL);
if (!result) {
debug("Failed to query the CD TOC: %d", (int)GetLastError());
return false;
}
_firstTrack = tocData.FirstTrack;
_lastTrack = tocData.LastTrack;
#if 0
debug("First Track: %d", tocData.FirstTrack);
debug("Last Track: %d", tocData.LastTrack);
#endif
for (uint32 i = 0; i < (bytesReturned - 4) / sizeof(TRACK_DATA); i++)
_tocEntries.push_back(tocData.TrackData[i]);
#if 0
for (uint32 i = 0; i < _tocEntries.size(); i++) {
const TRACK_DATA &entry = _tocEntries[i];
debug("Entry:");
debug("\tTrack: %d", entry.TrackNumber);
debug("\tAdr: %d", entry.Adr);
debug("\tCtrl: %d", entry.Control);
debug("\tMSF: %d:%d:%d\n", entry.Address[1], entry.Address[2], entry.Address[3]);
}
#endif
return true;
}
Win32AudioCDManager::DriveList Win32AudioCDManager::detectDrives() {
DriveList drives;
// Try to get the game path's drive
char gameDrive = 0;
if (ConfMan.hasKey("path")) {
Common::String gamePath = ConfMan.get("path");
char fullPath[MAX_PATH];
DWORD result = GetFullPathNameA(gamePath.c_str(), sizeof(fullPath), fullPath, 0);
if (result > 0 && result < sizeof(fullPath) && Common::isAlpha(fullPath[0]) && fullPath[1] == ':' && tryAddDrive(toupper(fullPath[0]), drives))
gameDrive = drives[0];
}
// Try adding the rest of the drives
for (char drive = 'A'; drive <= 'Z'; drive++)
if (drive != gameDrive)
tryAddDrive(drive, drives);
return drives;
}
bool Win32AudioCDManager::tryAddDrive(char drive, DriveList &drives) {
Common::String drivePath = Common::String::format("%c:\\", drive);
// Ensure it's an actual CD drive
if (GetDriveTypeA(drivePath.c_str()) != DRIVE_CDROM)
return false;
debug(2, "Detected drive %c:\\ as a CD drive", drive);
drives.push_back(drive);
return true;
}
AudioCDManager *createWin32AudioCDManager() {
return new Win32AudioCDManager();
}
|