summaryrefslogtreecommitdiffstatshomepage
path: root/src/emu/speaker.h
blob: e4f62fb4661124cacbba610b20d2a5fe71c0ad63 (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
// license:BSD-3-Clause
// copyright-holders:Aaron Giles
/***************************************************************************

    speaker.h

    Speaker output sound device.

    Speakers have (x, y, z) coordinates in 3D space:
    * Observer is at position (0, 0, 0)
    * Positive x is to the right of the observer
    * Negative x is to the left of the observer
    * Positive y is above the observer
    * Negative y is below the observer
    * Positive z is in front of the observer
    * Negative z is behind the observer

    Currently, MAME only considers the sign of the x coordinate (not its
    magnitude), and completely ignores the y and z coordinates.

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

#ifndef MAME_EMU_SPEAKER_H
#define MAME_EMU_SPEAKER_H

#pragma once


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

// device type definition
DECLARE_DEVICE_TYPE(SPEAKER, speaker_device)



//**************************************************************************
//  TYPE DEFINITIONS
//**************************************************************************

// ======================> speaker_device

class speaker_device : public device_t, public device_mixer_interface
{
public:
	// construction/destruction
	speaker_device(const machine_config &mconfig, const char *tag, device_t *owner, double x, double y, double z)
		: speaker_device(mconfig, tag, owner, 0)
	{
		set_position(x, y, z);
	}
	speaker_device(const machine_config &mconfig, const char *tag, device_t *owner, u32 clock = 0);
	virtual ~speaker_device();

	// inline configuration helpers
	speaker_device &set_position(double x, double y, double z) { m_x = x; m_y = y; m_z = z; return *this; }
	speaker_device &front_center()      { set_position( 0.0,  0.0,  1.0); return *this; }
	speaker_device &front_left()        { set_position(-0.2,  0.0,  1.0); return *this; }
	speaker_device &front_floor()       { set_position( 0.0, -0.5,  1.0); return *this; }
	speaker_device &front_right()       { set_position( 0.2,  0.0,  1.0); return *this; }
	speaker_device &rear_center()       { set_position( 0.0,  0.0, -0.5); return *this; }
	speaker_device &rear_left()         { set_position(-0.2,  0.0, -0.5); return *this; }
	speaker_device &rear_right()        { set_position( 0.2,  0.0, -0.5); return *this; }
	speaker_device &headrest_center()   { set_position( 0.0,  0.0, -0.1); return *this; }
	speaker_device &headrest_left()     { set_position(-0.1,  0.0, -0.1); return *this; }
	speaker_device &headrest_right()    { set_position( 0.1,  0.0, -0.1); return *this; }
	speaker_device &seat()              { set_position( 0.0, -0.5,  0.0); return *this; }
	speaker_device &backrest()          { set_position( 0.0, -0.2,  0.1); return *this; }

	// internally for use by the sound system
	void mix(s32 *leftmix, s32 *rightmix, int &samples_this_update, bool suppress);

protected:
	// device-level overrides
	virtual void device_start() override ATTR_COLD;

	// inline configuration state
	double              m_x;
	double              m_y;
	double              m_z;

	// internal state
#ifdef MAME_DEBUG
	s32                 m_max_sample;           // largest sample value we've seen
	s32                 m_clipped_samples;      // total number of clipped samples
	s32                 m_total_samples;        // total number of samples
#endif
};


// speaker device iterator
typedef device_type_iterator<speaker_device> speaker_device_iterator;


#endif // MAME_EMU_SPEAKER_H