#include <MSXMixer.hh>

Inheritance diagram for openmsx::MSXMixer:

[legend]

Collaboration diagram for openmsx::MSXMixer:

[legend]

Classes
struct	SoundDeviceInfo

Public Member Functions
	MSXMixer (const MSXMixer &)=delete

MSXMixer &	operator= (const MSXMixer &)=delete

	MSXMixer (Mixer &mixer, MSXMotherBoard &motherBoard, GlobalSettings &globalSettings)

	~MSXMixer ()

void	registerSound (SoundDevice &device, float volume, int balance, unsigned numChannels)
	Use this method to register a given SoundDevice.

void	unregisterSound (SoundDevice &device)
	Every SoundDevice must unregister before it is destructed.

void	updateStream (EmuTime::param time)
	Use this method to force an 'early' call to all updateBuffer() methods.

void	updateSoftwareVolume (SoundDevice &device)
	Used by SoundDevice::setSoftwareVolume()

double	getEffectiveSpeed () const
	Returns the ratio of EmuTime-speed per realtime-speed.

void	setSynchronousMode (bool synchronous)
	If we're recording, we want to emulate sound at 100% EmuTime speed.

bool	isSynchronousMode () const

void	mute ()
	TODO This methods (un)mute the sound.

void	unmute ()

void	setMixerParams (unsigned fragmentSize, unsigned sampleRate)
	Set new fragment size and sample frequency.

const DynamicClock &	getHostSampleClock () const
	Clock that ticks at the exact moment(s) in time that a host sample should be generated.

bool	needStereoRecording () const

void	setRecorder (AviRecorder *recorder)

unsigned	getSampleRate () const

SoundDevice *	findDevice (std::string_view name) const

const SoundDeviceInfo *	findDeviceInfo (std::string_view name) const

const auto &	getDeviceInfos () const

void	reInit ()

Static Public Attributes
static constexpr int	AMP_BITS = 9

Detailed Description

Definition at line 32 of file MSXMixer.hh.

Constructor & Destructor Documentation

◆ MSXMixer() [1/2]

openmsx::MSXMixer::MSXMixer ( const MSXMixer & )

delete

◆ MSXMixer() [2/2]

openmsx::MSXMixer::MSXMixer	(	Mixer &	mixer,
		MSXMotherBoard &	motherBoard,
		GlobalSettings &	globalSettings
	)

Definition at line 41 of file MSXMixer.cc.

References openmsx::Subject< T >::attach(), and unmute().

◆ ~MSXMixer()

openmsx::MSXMixer::~MSXMixer ( )

Definition at line 66 of file MSXMixer.cc.

References openmsx::Subject< T >::detach(), mute(), and openmsx::AviRecorder::stop().

Member Function Documentation

◆ findDevice()

SoundDevice * openmsx::MSXMixer::findDevice ( std::string_view name ) const

Definition at line 818 of file MSXMixer.cc.

References findDeviceInfo().

◆ findDeviceInfo()

const MSXMixer::SoundDeviceInfo * openmsx::MSXMixer::findDeviceInfo ( std::string_view name ) const

Definition at line 811 of file MSXMixer.cc.

References end(), and ranges::find().

Referenced by findDevice().

◆ getDeviceInfos()

const auto & openmsx::MSXMixer::getDeviceInfos ( ) const

inline

Definition at line 140 of file MSXMixer.hh.

Referenced by openmsx::ImGuiSoundChip::paint().

◆ getEffectiveSpeed()

double openmsx::MSXMixer::getEffectiveSpeed ( ) const

Returns the ratio of EmuTime-speed per realtime-speed.

In other words how many times faster EmuTime goes compared to realtime. This depends on the 'speed' setting but also on whether we're recording or not (in case of recording we want to generate sound as if realtime and EmuTime go at the same speed.

Definition at line 156 of file MSXMixer.cc.

References openmsx::SpeedManager::getSpeed().

Referenced by reInit().

◆ getHostSampleClock()

const DynamicClock & openmsx::MSXMixer::getHostSampleClock ( ) const

inline

Clock that ticks at the exact moment(s) in time that a host sample should be generated.

The current time of this clock is the time of the last generated sample. The rate of this clock is the same as the host sample rate. Note that this rate is not the same as the frequency set with the 'frequency' setting. Either because the sound driver can't handle the requested speed or because the 'speed' setting is different from 100.

Definition at line 129 of file MSXMixer.hh.

◆ getSampleRate()

unsigned openmsx::MSXMixer::getSampleRate ( ) const

inline

Definition at line 136 of file MSXMixer.hh.

Referenced by openmsx::AviRecorder::addWave(), and registerSound().

◆ isSynchronousMode()

bool openmsx::MSXMixer::isSynchronousMode ( ) const

inline

Definition at line 103 of file MSXMixer.hh.

◆ mute()

void openmsx::MSXMixer::mute ( )

TODO This methods (un)mute the sound.

These methods may be called multiple times, as long as you never call unmute() more than mute()

Definition at line 611 of file MSXMixer.cc.

References openmsx::Mixer::unregisterMixer().

Referenced by ~MSXMixer().

◆ needStereoRecording()

bool openmsx::MSXMixer::needStereoRecording ( ) const

Definition at line 603 of file MSXMixer.cc.

References ranges::any_of().

◆ operator=()

MSXMixer & openmsx::MSXMixer::operator= ( const MSXMixer & )

delete

◆ registerSound()

void openmsx::MSXMixer::registerSound	(	SoundDevice &	device,
		float	volume,
		int	balance,
		unsigned	numChannels
	)

Use this method to register a given SoundDevice.

While registering, the device its setSampleRate() method is called (see SoundDevice for more info). After registration the device its updateBuffer() method is 'regularly' called (see SoundDevice for more info).

Definition at line 85 of file MSXMixer.cc.

References openmsx::MSXMixer::SoundDeviceInfo::balanceSetting, openmsx::MSXMixer::SoundDeviceInfo::channelSettings, openmsx::MSXMixer::SoundDeviceInfo::defaultVolume, openmsx::MSXMixer::SoundDeviceInfo::device, openmsx::Setting::DONT_SAVE, enumerate(), openmsx::MSXCommandController::getCliComm(), openmsx::SoundDevice::getName(), getSampleRate(), openmsx::SpeedManager::getSpeed(), openmsx::SoundDevice::setOutputRate(), openmsx::CliComm::SOUND_DEVICE, tmpStrCat(), openmsx::MSXCliComm::update(), and openmsx::MSXMixer::SoundDeviceInfo::volumeSetting.