Public Member Functions | List of all members
openmsx::SamplePlayer Class Referencefinal

#include <SamplePlayer.hh>

Inheritance diagram for openmsx::SamplePlayer:
Inheritance graph
Collaboration diagram for openmsx::SamplePlayer:
Collaboration graph

Public Member Functions

 SamplePlayer (const std::string &name, static_string_view desc, const DeviceConfig &config, std::string_view samplesBaseName, unsigned numSamples, std::string_view alternativeName={})
 ~SamplePlayer ()
void reset ()
void play (unsigned sampleNum)
 Start playing a (new) sample. More...
void repeat (unsigned sampleNum)
 Keep on repeating the given sample data. More...
void stopRepeat ()
 Stop repeat mode. More...
bool isPlaying () const
 Is there currently playing a sample. More...
template<typename Archive >
void serialize (Archive &ar, unsigned version)
- Public Member Functions inherited from openmsx::ResampledSoundDevice
bool generateInput (float *buffer, unsigned num)
 Note: To enable various optimizations (like SSE), this method is allowed to generate up to 3 extra sample. More...
DynamicClockgetEmuClock ()
- Public Member Functions inherited from openmsx::SoundDevice
 SoundDevice (const SoundDevice &)=delete
SoundDeviceoperator= (const SoundDevice &)=delete
const std::string & getName () const
 Get the unique name that identifies this sound device. More...
std::string_view getDescription () const
 Gets a description of this sound device, to be presented to the user. More...
bool isStereo () const
 Is this a stereo device? This is set in the constructor and cannot be changed anymore. More...
AmplificationFactors getAmplificationFactor () const
void setSoftwareVolume (float volume, EmuTime::param time)
 Change the 'software volume' of this sound device. More...
void setSoftwareVolume (float left, float right, EmuTime::param time)
void recordChannel (unsigned channel, const Filename &filename)
void muteChannel (unsigned channel, bool muted)

Additional Inherited Members

- Public Types inherited from openmsx::ResampledSoundDevice
- Static Public Attributes inherited from openmsx::SoundDevice
static constexpr unsigned MAX_CHANNELS = 24
- Protected Member Functions inherited from openmsx::ResampledSoundDevice
 ResampledSoundDevice (MSXMotherBoard &motherBoard, std::string_view name, static_string_view description, unsigned channels, unsigned inputSampleRate, bool stereo)
 ~ResampledSoundDevice ()
void setOutputRate (unsigned hostSampleRate, double speed) override
 When a SoundDevice registers itself with the Mixer, the Mixer sets the required sampleRate through this method. More...
bool updateBuffer (unsigned length, float *buffer, EmuTime::param time) override
 Generate sample data. More...
void update (const Setting &setting) noexcept override
void createResampler ()
- Protected Member Functions inherited from openmsx::SoundDevice
 SoundDevice (MSXMixer &mixer, std::string_view name, static_string_view description, unsigned numChannels, unsigned inputRate, bool stereo)
 Constructor. More...
 ~SoundDevice ()
virtual float getAmplificationFactorImpl () const
 Get amplification/attenuation factor for this device. More...
void registerSound (const DeviceConfig &config)
 Registers this sound device with the Mixer. More...
void unregisterSound ()
 Unregisters this sound device with the Mixer. More...
void updateStream (EmuTime::param time)
void setInputRate (unsigned sampleRate)
unsigned getInputRate () const
bool mixChannels (float *dataOut, unsigned samples)
 Calls generateChannels() and combines the output to a single channel. More...
const DynamicClockgetHostSampleClock () const
 See MSXMixer::getHostSampleClock(). More...
double getEffectiveSpeed () const
- Protected Member Functions inherited from openmsx::Observer< Setting >
 Observer ()=default
 ~Observer ()=default
 Observer (const Observer &)=delete
Observeroperator= (const Observer &)=delete
virtual void subjectDeleted (const Setting &)
- Static Protected Member Functions inherited from openmsx::SoundDevice
static void addFill (float *&buffer, float value, unsigned num)
 Adds a number of samples that all have the same value. More...

Detailed Description

Definition at line 10 of file SamplePlayer.hh.

Constructor & Destructor Documentation

◆ SamplePlayer()

openmsx::SamplePlayer::SamplePlayer ( const std::string &  name,
static_string_view  desc,
const DeviceConfig config,
std::string_view  samplesBaseName,
unsigned  numSamples,
std::string_view  alternativeName = {} 

Definition at line 49 of file

References openmsx::SoundDevice::registerSound(), and reset().

◆ ~SamplePlayer()

openmsx::SamplePlayer::~SamplePlayer ( )

Definition at line 61 of file

References openmsx::SoundDevice::unregisterSound().

Member Function Documentation

◆ isPlaying()

bool openmsx::SamplePlayer::isPlaying ( ) const

Is there currently playing a sample.

Definition at line 42 of file SamplePlayer.hh.

Referenced by openmsx::RomPlayBall::peekMem(), repeat(), and openmsx::RomPlayBall::writeMem().

◆ play()

void openmsx::SamplePlayer::play ( unsigned  sampleNum)

Start playing a (new) sample.

Definition at line 72 of file

Referenced by openmsx::RomPlayBall::writeMem().

◆ repeat()

void openmsx::SamplePlayer::repeat ( unsigned  sampleNum)

Keep on repeating the given sample data.

If there is already a sample playing, that sample is still finished. If there was no sample playing, the given sample immediately starts playing. Parameters are the same as for the play() method.

See also

Definition at line 100 of file

References isPlaying().

Referenced by openmsx::RomNettouYakyuu::writeMem().

◆ reset()

void openmsx::SamplePlayer::reset ( )

◆ serialize()

template<typename Archive >
void openmsx::SamplePlayer::serialize ( Archive &  ar,
unsigned  version 

Definition at line 141 of file

◆ stopRepeat()

void openmsx::SamplePlayer::stopRepeat ( )

Stop repeat mode.

The currently playing sample will still be finished, but won't be started.

See also

Definition at line 39 of file SamplePlayer.hh.

Referenced by reset(), and openmsx::RomNettouYakyuu::writeMem().

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