summaryrefslogtreecommitdiffstatshomepage
path: root/src/emu/speaker.cpp
blob: 33b1e8d329a072264a234f8d605bfac5c37522b5 (plain) (blame)
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
// license:BSD-3-Clause
// copyright-holders:Aaron Giles
/***************************************************************************

    speaker.cpp

    Speaker output sound device.

***************************************************************************/

#include "emu.h"
#include "emuopts.h"
#include "speaker.h"



//**************************************************************************
//  GLOBAL VARIABLES
//**************************************************************************

// device type definition
DEFINE_DEVICE_TYPE(SPEAKER, speaker_device, "speaker", "Speaker")



//**************************************************************************
//  LIVE SPEAKER DEVICE
//**************************************************************************

//-------------------------------------------------
//  speaker_device - constructor
//-------------------------------------------------

speaker_device::speaker_device(const machine_config &mconfig, const char *tag, device_t *owner, u32 clock)
	: device_t(mconfig, SPEAKER, tag, owner, clock)
	, device_mixer_interface(mconfig, *this)
	, m_x(0.0)
	, m_y(0.0)
	, m_z(0.0)
	, m_pan(0.0)
	, m_defpan(0.0)
	, m_current_max(0)
	, m_samples_this_bucket(0)
{
}


//-------------------------------------------------
//  ~speaker_device - destructor
//-------------------------------------------------

speaker_device::~speaker_device()
{
}


//-------------------------------------------------
//  set_position - set speaker position
//-------------------------------------------------

speaker_device &speaker_device::set_position(double x, double y, double z)
{
	// as mentioned in the header file, y and z params currently have no effect
	m_x = x;
	m_y = y;
	m_z = z;

	// hard pan to left
	if (m_x < 0.0)
		set_pan(-1.0f);

	// hard pan to right
	else if (m_x > 0.0)
		set_pan(1.0f);

	// center (mono)
	else
		set_pan(0.0f);

	m_defpan = m_pan;
	return *this;
}


//-------------------------------------------------
//  mix - mix in samples from the speaker's stream
//-------------------------------------------------

void speaker_device::mix(stream_buffer::sample_t *leftmix, stream_buffer::sample_t *rightmix, attotime start, attotime end, int expected_samples, bool suppress)
{
	// skip if no stream
	if (m_mixer_stream == nullptr)
		return;

	// skip if invalid range
	if (start > end)
		return;

	// get a view on the desired range
	read_stream_view view = m_mixer_stream->update_view(start, end);
	sound_assert(view.samples() >= expected_samples);

	// track maximum sample value for each 0.1s bucket
	if (machine().options().speaker_report() != 0)
	{
		u32 samples_per_bucket = m_mixer_stream->sample_rate() / BUCKETS_PER_SECOND;
		for (int sample = 0; sample < expected_samples; sample++)
		{
			m_current_max = std::max(m_current_max, fabsf(view.get(sample)));
			if (++m_samples_this_bucket >= samples_per_bucket)
			{
				m_max_sample.push_back(m_current_max);
				m_current_max = 0.0f;
				m_samples_this_bucket = 0;
			}
		}
	}

	// mix if sound is enabled
	if (!suppress)
	{
		// if the speaker is hard panned to the left, send only to the left
		if (m_pan == -1.0f)
			for (int sample = 0; sample < expected_samples; sample++)
				leftmix[sample] += view.get(sample);

		// if the speaker is hard panned to the right, send only to the right
		else if (m_pan == 1.0f)
			for (int sample = 0; sample < expected_samples; sample++)
				rightmix[sample] += view.get(sample);

		// otherwise, send to both
		else
		{
			const float leftpan = (m_pan <= 0.0f) ? 1.0f : 1.0f - m_pan;
			const float rightpan = (m_pan >= 0.0f) ? 1.0f : 1.0f + m_pan;

			for (int sample = 0; sample < expected_samples; sample++)
			{
				stream_buffer::sample_t cursample = view.get(sample);
				leftmix[sample] += cursample * leftpan;
				rightmix[sample] += cursample * rightpan;
			}
		}
	}
}


//-------------------------------------------------
//  device_start - handle device startup
//-------------------------------------------------

void speaker_device::device_start()
{
}


//-------------------------------------------------
//  device_stop - cleanup and report
//-------------------------------------------------

void speaker_device::device_stop()
{
	// level 1: just report if there was any clipping
	// level 2: report the overall maximum, even if no clipping
	// level 3: print a detailed list of all the times there was clipping
	// level 4: print a detailed list of every bucket
	int report = machine().options().speaker_report();
	if (report != 0)
	{
		m_max_sample.push_back(m_current_max);

		// determine overall maximum and number of clipped buckets
		stream_buffer::sample_t overallmax = 0;
		u32 clipped = 0;
		for (auto &curmax : m_max_sample)
		{
			overallmax = std::max(overallmax, curmax);
			if (curmax > stream_buffer::sample_t(1.0))
				clipped++;
		}

		// levels 1 and 2 just get a summary
		if (clipped != 0 || report == 2 || report == 4)
			osd_printf_info("Speaker \"%s\" - max = %.5f (gain *= %.3f) - clipped in %d/%d (%d%%) buckets\n", tag(), overallmax, 1 / (overallmax ? overallmax : 1), clipped, m_max_sample.size(), clipped * 100 / m_max_sample.size());

		// levels 3 and 4 get a full dump
		if (report >= 3)
		{
			static char const * const s_stars  = "************************************************************";
			static char const * const s_spaces = "                                                            ";
			int totalstars = strlen(s_stars);
			double t = 0;
			if (overallmax < 1.0)
				overallmax = 1.0;
			int leftstars = totalstars / overallmax;
			for (auto &curmax : m_max_sample)
			{
				if (curmax > stream_buffer::sample_t(1.0) || report == 4)
				{
					osd_printf_info("%6.1f: %9.5f |", t, curmax);
					if (curmax == 0)
						osd_printf_info("%.*s|\n", leftstars, s_spaces);
					else if (curmax <= 1.0)
					{
						int stars = std::max(1, std::min(leftstars, int(curmax * totalstars / overallmax)));
						osd_printf_info("%.*s", stars, s_stars);
						int spaces = leftstars - stars;
						if (spaces != 0)
							osd_printf_info("%.*s", spaces, s_spaces);
						osd_printf_info("|\n");
					}
					else
					{
						int rightstars = std::max(1, std::min(totalstars, int(curmax * totalstars / overallmax)) - leftstars);
						osd_printf_info("%.*s|%.*s\n", leftstars, s_stars, rightstars, s_stars);
					}
				}
				t += 1.0 / double(BUCKETS_PER_SECOND);
			}
		}
	}
}