openMSX
Classes | Public Member Functions | Static Public Attributes | List of all members
openmsx::MSXMixer Class Referencefinal

#include <MSXMixer.hh>

Inheritance diagram for openmsx::MSXMixer:
Inheritance graph
[legend]
Collaboration diagram for openmsx::MSXMixer:
Collaboration graph
[legend]

Public Member Functions

 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. More...
 
void unregisterSound (SoundDevice &device)
 Every sounddevice must unregister before it is destructed. More...
 
void updateStream (EmuTime::param time)
 Use this method to force an 'early' call to all updateBuffer() methods. More...
 
void updateSoftwareVolume (SoundDevice &device)
 Used by SoundDevice::setSoftwareVolume() More...
 
double getEffectiveSpeed () const
 Returns the ratio of emutime-speed per realtime-speed. More...
 
void setSynchronousMode (bool synchronous)
 If we're recording, we want to emulate sound at 100% emutime speed. More...
 
void mute ()
 TODO This methods (un)mute the sound. More...
 
void unmute ()
 
void setMixerParams (unsigned fragmentSize, unsigned sampleRate)
 Set new fragment size and sample frequency. More...
 
const DynamicClockgetHostSampleClock () const
 Clock that ticks at the exact moment(s) in time that a host sample should be generated. More...
 
bool needStereoRecording () const
 
void setRecorder (AviRecorder *recorder)
 
unsigned getSampleRate () const
 
SoundDevicefindDevice (string_view name) const
 
void reInit ()
 

Static Public Attributes

static constexpr int AMP_BITS = 9
 

Detailed Description

Definition at line 26 of file MSXMixer.hh.

Constructor & Destructor Documentation

◆ MSXMixer()

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

Definition at line 38 of file MSXMixer.cc.

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

◆ ~MSXMixer()

openmsx::MSXMixer::~MSXMixer ( )

Definition at line 65 of file MSXMixer.cc.

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

Member Function Documentation

◆ findDevice()

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

◆ 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 154 of file MSXMixer.cc.

References openmsx::IntegerSetting::getInt().

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 103 of file MSXMixer.hh.

References needStereoRecording(), and setRecorder().

◆ getSampleRate()

unsigned openmsx::MSXMixer::getSampleRate ( ) const
inline

◆ 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 547 of file MSXMixer.cc.

References openmsx::Mixer::unregisterMixer().

Referenced by openmsx::MSXTurboRPCM::writeIO(), ~MSXMixer(), and openmsx::ReverseManager::~ReverseManager().

◆ needStereoRecording()

bool openmsx::MSXMixer::needStereoRecording ( ) const

Definition at line 539 of file MSXMixer.cc.

References ranges::any_of().

Referenced by getHostSampleClock(), and openmsx::AviRecorder::~AviRecorder().

◆ 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 79 of file MSXMixer.cc.

References openmsx::Setting::DONT_SAVE, openmsx::SoundDevice::getName(), getSampleRate(), openmsx::MSXMixer::SoundDeviceInfo::ChannelSettings::muteSetting, openmsx::MSXMixer::SoundDeviceInfo::ChannelSettings::recordSetting, openmsx::SoundDevice::setOutputRate(), openmsx::CliComm::SOUNDDEVICE, and strCat().

◆ reInit()

void openmsx::MSXMixer::reInit ( )

◆ setMixerParams()

void openmsx::MSXMixer::setMixerParams ( unsigned  fragmentSize,
unsigned  sampleRate 
)

Set new fragment size and sample frequency.

A fragment size of zero means the Mixer is muted.

Definition at line 581 of file MSXMixer.cc.

References reInit().

Referenced by setRecorder(), and setSynchronousMode().

◆ setRecorder()

void openmsx::MSXMixer::setRecorder ( AviRecorder recorder)

◆ setSynchronousMode()

void openmsx::MSXMixer::setSynchronousMode ( bool  synchronous)

If we're recording, we want to emulate sound at 100% emutime speed.

See alsoe getEffectiveSpeed().

Definition at line 137 of file MSXMixer.cc.

References setMixerParams().

Referenced by setRecorder().

◆ unmute()

void openmsx::MSXMixer::unmute ( )

Definition at line 555 of file MSXMixer.cc.

References openmsx::Mixer::registerMixer().

Referenced by MSXMixer(), and openmsx::MSXTurboRPCM::writeIO().

◆ unregisterSound()

void openmsx::MSXMixer::unregisterSound ( SoundDevice device)

◆ updateSoftwareVolume()

void openmsx::MSXMixer::updateSoftwareVolume ( SoundDevice device)

◆ updateStream()

void openmsx::MSXMixer::updateStream ( EmuTime::param  time)

Use this method to force an 'early' call to all updateBuffer() methods.

Definition at line 161 of file MSXMixer.cc.

References openmsx::AviRecorder::addWave(), ranges::count(), openmsx::DynamicClock::getTicksTill(), and openmsx::Mixer::uploadBuffer().

Referenced by openmsx::AviRecorder::addImage(), and updateSoftwareVolume().

Member Data Documentation

◆ AMP_BITS

constexpr int openmsx::MSXMixer::AMP_BITS = 9
static

Definition at line 32 of file MSXMixer.hh.


The documentation for this class was generated from the following files: