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
|
// license:BSD-3-Clause
// copyright-holders:Aaron Giles
/**********************************************************************************************
*
* Ensoniq ES5505/6 driver
* by Aaron Giles
*
**********************************************************************************************/
#ifndef MAME_SOUND_ES5506_H
#define MAME_SOUND_ES5506_H
#pragma once
#define ES5506_MAKE_WAVS 0
class es550x_device : public device_t, public device_sound_interface, public device_memory_interface
{
public:
template <typename T> void set_region0(T &&tag) { m_region0.set_tag(std::forward<T>(tag)); }
template <typename T> void set_region1(T &&tag) { m_region1.set_tag(std::forward<T>(tag)); }
template <typename T> void set_region2(T &&tag) { m_region2.set_tag(std::forward<T>(tag)); }
template <typename T> void set_region3(T &&tag) { m_region3.set_tag(std::forward<T>(tag)); }
void set_channels(int channels) { m_channels = channels; }
u32 get_voice_index() { return m_voice_index; }
auto irq_cb() { return m_irq_cb.bind(); }
auto read_port_cb() { return m_read_port_cb.bind(); }
auto sample_rate_changed() { return m_sample_rate_changed_cb.bind(); }
protected:
enum {
LP3 = 1,
LP4 = 2,
LP_MASK = LP3 | LP4
};
// constants for volumes
const s8 VOLUME_ACC_BIT = 20;
// constants for address
const s8 ADDRESS_FRAC_BIT = 11;
// struct describing a single playing voice
struct es550x_voice
{
es550x_voice() { }
// external state
u32 control = 0; // control register
u64 freqcount = 0; // frequency count register
u64 start = 0; // start register
u32 lvol = 0; // left volume register
u64 end = 0; // end register
u32 lvramp = 0; // left volume ramp register
u64 accum = 0; // accumulator register
u32 rvol = 0; // right volume register
u32 rvramp = 0; // right volume ramp register
u32 ecount = 0; // envelope count register
u32 k2 = 0; // k2 register
u32 k2ramp = 0; // k2 ramp register
u32 k1 = 0; // k1 register
u32 k1ramp = 0; // k1 ramp register
s32 o4n1 = 0; // filter storage O4(n-1)
s32 o3n1 = 0; // filter storage O3(n-1)
s32 o3n2 = 0; // filter storage O3(n-2)
s32 o2n1 = 0; // filter storage O2(n-1)
s32 o2n2 = 0; // filter storage O2(n-2)
s32 o1n1 = 0; // filter storage O1(n-1)
u64 exbank = 0; // external address bank
// internal state
u8 index = 0; // index of this voice
u8 filtcount = 0; // filter count
};
es550x_device(const machine_config &mconfig, device_type type, const char *tag, device_t *owner, u32 clock);
// device-level overrides
virtual void device_start() override;
virtual void device_clock_changed() override;
virtual void device_stop() override;
virtual void device_reset() override;
// sound stream update overrides
virtual void sound_stream_update(sound_stream &stream, std::vector<read_stream_view> const &inputs, std::vector<write_stream_view> &outputs) override;
void update_irq_state();
void update_internal_irq_state();
void compute_tables(u32 total_volume_bit = 16, u32 exponent_bit = 4, u32 mantissa_bit = 8);
void get_accum_mask(u32 address_integer = 21, u32 address_frac = 11);
virtual inline u32 get_bank(u32 control) { return 0; }
virtual inline u32 get_ca(u32 control) { return 0; }
virtual inline u32 get_lp(u32 control) { return 0; }
template<typename T, typename U> inline T lshift_signed(T val, U shift) { return (shift >= 0) ? val << shift : val >> (-shift); }
template<typename T, typename U> inline T rshift_signed(T val, U shift) { return (shift >= 0) ? val >> shift : val << (-shift); }
inline u64 get_volume(u32 volume) { return m_volume_lookup[rshift_signed<u32, s8>(volume, m_volume_shift)]; }
inline u64 get_address_acc_shifted_val(u64 val, int bias = 0) { return lshift_signed<u64, s8>(val, m_address_acc_shift - bias); }
inline u64 get_address_acc_res(u64 val, int bias = 0) { return rshift_signed<u64, s8>(val, m_address_acc_shift - bias); }
inline u64 get_integer_addr(u64 accum, s32 bias = 0) { return ((accum + (bias << ADDRESS_FRAC_BIT)) & m_address_acc_mask) >> ADDRESS_FRAC_BIT; }
inline s64 get_sample(s32 sample, u32 volume) { return rshift_signed<s64, s8>(sample * get_volume(volume), m_volume_acc_shift); }
inline s32 interpolate(s32 sample1, s32 sample2, u64 accum);
inline void apply_filters(es550x_voice *voice, s32 &sample);
virtual void update_envelopes(es550x_voice *voice) = 0;
virtual void check_for_end_forward(es550x_voice *voice, u64 &accum) = 0;
virtual void check_for_end_reverse(es550x_voice *voice, u64 &accum) = 0;
void generate_ulaw(es550x_voice *voice, s32 *dest);
void generate_pcm(es550x_voice *voice, s32 *dest);
inline void generate_irq(es550x_voice *voice, int v);
virtual void generate_samples(std::vector<write_stream_view> &outputs) {}
inline void update_index(es550x_voice *voice) { m_voice_index = voice->index; }
virtual inline u16 read_sample(es550x_voice *voice, offs_t addr) { return 0; }
// internal state
sound_stream *m_stream; // which stream are we using
int m_sample_rate; // current sample rate
u32 m_master_clock; // master clock frequency
s8 m_address_acc_shift; // right shift accumulator for generate integer address
u64 m_address_acc_mask; // accumulator mask
s8 m_volume_shift; // right shift volume for generate integer volume
s64 m_volume_acc_shift; // right shift output for output normalizing
u8 m_current_page; // current register page
u8 m_active_voices; // number of active voices
u16 m_mode; // MODE register
u8 m_irqv; // IRQV register
u32 m_voice_index; // current voice index value
es550x_voice m_voice[32]; // the 32 voices
std::vector<s16> m_ulaw_lookup;
std::vector<u32> m_volume_lookup;
#if ES5506_MAKE_WAVS
std::vector<s32> m_scratch;
void * m_wavraw; // raw waveform
#endif
optional_memory_region m_region0; // memory region where the sample ROM lives
optional_memory_region m_region1; // memory region where the sample ROM lives
optional_memory_region m_region2; // memory region where the sample ROM lives
optional_memory_region m_region3; // memory region where the sample ROM lives
int m_channels; // number of output channels: 1 .. 6
devcb_write_line m_irq_cb; // irq callback
devcb_read16 m_read_port_cb; // input port read
devcb_write32 m_sample_rate_changed_cb; // callback for when sample rate is changed
};
class es5506_device : public es550x_device
{
public:
es5506_device(const machine_config &mconfig, const char *tag, device_t *owner, u32 clock);
~es5506_device() {}
u8 read(offs_t offset);
void write(offs_t offset, u8 data);
protected:
// device-level overrides
virtual void device_start() override;
virtual void device_reset() override;
// device_memory_interface configuration
virtual space_config_vector memory_space_config() const override;
address_space_config m_bank0_config;
address_space_config m_bank1_config;
address_space_config m_bank2_config;
address_space_config m_bank3_config;
const s8 VOLUME_BIT_ES5506 = 16;
const s8 ADDRESS_INTEGER_BIT_ES5506 = 21;
const s8 ADDRESS_FRAC_BIT_ES5506 = 11;
virtual inline u32 get_bank(u32 control) override { return (control >> 14) & 3; }
virtual inline u32 get_ca(u32 control) override { return (control >> 10) & 7; }
virtual inline u32 get_lp(u32 control) override { return (control >> 8) & LP_MASK; }
virtual void update_envelopes(es550x_voice *voice) override;
virtual void check_for_end_forward(es550x_voice *voice, u64 &accum) override;
virtual void check_for_end_reverse(es550x_voice *voice, u64 &accum) override;
virtual void generate_samples(std::vector<write_stream_view> &outputs) override;
virtual inline u16 read_sample(es550x_voice *voice, offs_t addr) override { update_index(voice); return m_cache[get_bank(voice->control)].read_word(addr); }
private:
inline void reg_write_low(es550x_voice *voice, offs_t offset, u32 data);
inline void reg_write_high(es550x_voice *voice, offs_t offset, u32 data);
inline void reg_write_test(es550x_voice *voice, offs_t offset, u32 data);
inline u32 reg_read_low(es550x_voice *voice, offs_t offset);
inline u32 reg_read_high(es550x_voice *voice, offs_t offset);
inline u32 reg_read_test(es550x_voice *voice, offs_t offset);
memory_access<21, 1, -1, ENDIANNESS_BIG>::cache m_cache[4];
// ES5506 specific registers
u32 m_write_latch; // currently accumulated data for write
u32 m_read_latch; // currently accumulated data for read
u8 m_wst; // W_ST register
u8 m_wend; // W_END register
u8 m_lrend; // LR_END register
};
DECLARE_DEVICE_TYPE(ES5506, es5506_device)
class es5505_device : public es550x_device
{
public:
es5505_device(const machine_config &mconfig, const char *tag, device_t *owner, u32 clock);
u16 read(offs_t offset);
void write(offs_t offset, u16 data, u16 mem_mask = ~0);
protected:
// device-level overrides
virtual void device_start() override;
// device_memory_interface configuration
virtual space_config_vector memory_space_config() const override;
address_space_config m_bank0_config;
address_space_config m_bank1_config;
const s8 VOLUME_BIT_ES5505 = 8;
const s8 ADDRESS_INTEGER_BIT_ES5505 = 20;
const s8 ADDRESS_FRAC_BIT_ES5505 = 9;
virtual inline u32 get_lp(u32 control) override { return (control >> 10) & LP_MASK; }
virtual inline u32 get_ca(u32 control) override { return (control >> 8) & 3; }
virtual inline u32 get_bank(u32 control) override { return (control >> 2) & 1; }
virtual void update_envelopes(es550x_voice *voice) override;
virtual void check_for_end_forward(es550x_voice *voice, u64 &accum) override;
virtual void check_for_end_reverse(es550x_voice *voice, u64 &accum) override;
virtual void generate_samples(std::vector<write_stream_view> &outputs) override;
virtual inline u16 read_sample(es550x_voice *voice, offs_t addr) override { update_index(voice); return m_cache[get_bank(voice->control)].read_word(addr); }
private:
// internal state
inline void reg_write_low(es550x_voice *voice, offs_t offset, u16 data, u16 mem_mask);
inline void reg_write_high(es550x_voice *voice, offs_t offset, u16 data, u16 mem_mask);
inline void reg_write_test(es550x_voice *voice, offs_t offset, u16 data, u16 mem_mask);
inline u16 reg_read_low(es550x_voice *voice, offs_t offset);
inline u16 reg_read_high(es550x_voice *voice, offs_t offset);
inline u16 reg_read_test(es550x_voice *voice, offs_t offset);
memory_access<20, 1, -1, ENDIANNESS_BIG>::cache m_cache[2];
};
DECLARE_DEVICE_TYPE(ES5505, es5505_device)
#endif // MAME_SOUND_ES5506_H
|