File: cms.h

package info (click to toggle)
scummvm 2.7.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 363,784 kB
  • sloc: cpp: 3,622,060; asm: 27,410; python: 10,528; sh: 10,241; xml: 6,752; java: 5,579; perl: 2,570; yacc: 1,635; javascript: 1,016; lex: 539; makefile: 398; ansic: 378; awk: 275; objc: 82; sed: 11; php: 1
file content (173 lines) | stat: -rw-r--r-- 4,065 bytes parent folder | download
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
/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM 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 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/>.
 *
 */

#ifndef AUDIO_CMS_H
#define AUDIO_CMS_H

#include "common/func.h"
#include "common/ptr.h"

#include "audio/audiostream.h"
#include "audio/mixer.h"

namespace CMS {

class CMS;

class Config {
public:
	/**
	 * Creates a CMS driver.
	 */
	static CMS *create();
};

/**
 * The type of the CMS timer callback functor.
 */
typedef Common::Functor0<void> TimerCallback;

class CMS {
private:
	static bool _hasInstance;

public:
	// The default number of timer callbacks per second.
	static const int DEFAULT_CALLBACK_FREQUENCY = 250;

	CMS();
	virtual ~CMS();

	/**
	 * Initializes the CMS emulator.
	 *
	 * @return		true on success, false on failure
	 */
	virtual bool init() = 0;

	/**
	 * Reinitializes the CMS emulator
	 */
	virtual void reset() = 0;

	/**
	 * Writes a byte to the given I/O port. CMS responds to 2 sets of 2 ports:
	 * 0x220/0x222 - value for the 1st/2nd chip (channels 0-5/6-B)
	 * 0x221/0x223 - register for the 1st/2nd chip
	 *
	 * @param a		port address
	 * @param v		value, which will be written
	 */
	virtual void write(int a, int v) = 0;

	/**
	 * Function to directly write to a specific CMS register. We allow writing
	 * to secondary CMS chip registers by using register values >= 0x100.
	 *
	 * @param r		hardware register number to write to
	 * @param v		value, which will be written
	 */
	virtual void writeReg(int r, int v) = 0;

	/**
	 * Start the CMS with callbacks.
	 */
	void start(TimerCallback *callback, int timerFrequency = DEFAULT_CALLBACK_FREQUENCY);

	/**
	 * Stop the CMS
	 */
	void stop();

	/**
	 * Change the callback frequency. This must only be called from a
	 * timer proc.
	 */
	virtual void setCallbackFrequency(int timerFrequency) = 0;

protected:
	/**
	 * Start the callbacks.
	 */
	virtual void startCallbacks(int timerFrequency) = 0;

	/**
	 * Stop the callbacks.
	 */
	virtual void stopCallbacks() = 0;

	/**
	 * The functor for callbacks.
	 */
	Common::ScopedPtr<TimerCallback> _callback;
};

/**
 * A CMS that represents an emulated CMS.
 *
 * This will send callbacks based on the number of samples
 * decoded in readBuffer().
 */
class EmulatedCMS : public CMS, protected Audio::AudioStream {
protected:
	static const int FIXP_SHIFT = 16;

public:
	EmulatedCMS();
	virtual ~EmulatedCMS();

	// CMS API
	void setCallbackFrequency(int timerFrequency) override;

	// AudioStream API
	int readBuffer(int16 *buffer, const int numSamples) override;
	int getRate() const override;
	bool endOfData() const override;
	bool isStereo() const override;

protected:
	// CMS API
	void startCallbacks(int timerFrequency) override;
	void stopCallbacks() override;

	/**
	 * Read up to 'length' samples.
	 *
	 * Data will be in native endianess, 16 bit per sample, signed. buffer will
	 * be filled with interleaved left and right channel samples, starting with
	 * a left sample. The requested number of samples is stereo samples, so if
	 * you request 2 samples, you will get a total of two left channel and two
	 * right channel samples.
	 */
	virtual void generateSamples(int16 *buffer, int numSamples) = 0;

private:
	int _baseFreq;

	int _nextTick;
	int _samplesPerTick;

	Audio::SoundHandle *_handle;
};

} // End of namespace CMS

#endif