Represents a clock with a variable frequency. More...

#include <DynamicClock.hh>

Classes
struct	IntegralFractional
	Like getTicksTill(), but also returns the fractional part (in range [0, 1)). More...

Public Member Functions
	DynamicClock (EmuTime::param time)
	Create a new clock, which starts ticking at given time.

	DynamicClock (EmuTime::param time, unsigned freq)
	Create a new clock, which starts ticking at given time with given frequency.

EmuTime::param	getTime () const
	Gets the time at which the last clock tick occurred.

bool	before (EmuTime::param e) const
	Checks whether this clock's last tick is or is not before the given time stamp.

unsigned	getTicksTill (EmuTime::param e) const
	Calculate the number of ticks for this clock until the given time.

IntegralFractional	getTicksTillAsIntFloat (EmuTime::param e) const

template<typename FIXED >
void	getTicksTill (EmuTime::param e, FIXED &result) const

unsigned	getTicksTillUp (EmuTime::param e) const
	Calculate the number of ticks this clock has to tick to reach or go past the given time.

double	getTicksTillDouble (EmuTime::param e) const

uint64_t	getTotalTicks () const

void	setFreq (unsigned freq)
	Change the frequency at which this clock ticks.

void	setFreq (unsigned freq_num, unsigned freq_denom)
	Equivalent to setFreq(freq_num / freq_denom), but possibly with less rounding errors.

unsigned	getFreq () const
	Returns the frequency (in Hz) at which this clock ticks.

EmuDuration	getPeriod () const
	Returns the length of one clock-cycle.

void	setPeriod (EmuDuration period)
	Set the duration of a clock tick.

void	reset (EmuTime::param e)
	Reset the clock to start ticking at the given time.

void	advance (EmuTime::param e)
	Advance this clock in time until the last tick which is not past the given time.

void	operator+= (uint64_t n)
	Advance this clock by the given number of ticks.

EmuTime	operator+ (uint64_t n) const
	Calculate the time at which this clock will have ticked the given number of times (counted from its last tick).

void	fastAdd (unsigned n)
	Advance this clock by the given number of ticks.

EmuTime	getFastAdd (unsigned n) const

EmuTime	add (EmuTime::param time, unsigned n) const

template<typename Archive >
void	serialize (Archive &ar, unsigned version)

Detailed Description

Represents a clock with a variable frequency.

The frequency is in Hertz, so every tick is 1/frequency second. A clock has a current time, which can be increased by an integer number of ticks.

Definition at line 16 of file DynamicClock.hh.

Constructor & Destructor Documentation

◆ DynamicClock() [1/2]

openmsx::DynamicClock::DynamicClock ( EmuTime::param time )

inlineexplicit

Create a new clock, which starts ticking at given time.

The initial frequency is infinite; in other words, the clock stands still.

Definition at line 25 of file DynamicClock.hh.

◆ DynamicClock() [2/2]

openmsx::DynamicClock::DynamicClock	(	EmuTime::param	time,
		unsigned	freq
	)

inline

Create a new clock, which starts ticking at given time with given frequency.

Definition at line 30 of file DynamicClock.hh.

References setFreq().

Member Function Documentation

◆ add()

EmuTime openmsx::DynamicClock::add	(	EmuTime::param	time,
		unsigned	n
	)		const

inline

Definition at line 190 of file DynamicClock.hh.

Referenced by openmsx::CPUClock::calcTime(), and getFastAdd().

◆ advance()

void openmsx::DynamicClock::advance ( EmuTime::param e )

inline

Advance this clock in time until the last tick which is not past the given time.

It is not allowed to advance a clock to a time in the past.

Definition at line 155 of file DynamicClock.hh.

References openmsx::DivModBySame::mod().

Referenced by openmsx::CPUClock::advanceTime(), and openmsx::MC6850::writeDataReg().

◆ before()

bool openmsx::DynamicClock::before ( EmuTime::param e ) const

inline

Checks whether this clock's last tick is or is not before the given time stamp.

Definition at line 45 of file DynamicClock.hh.

Referenced by openmsx::TC8566AF::readDataPort(), and openmsx::TC8566AF::readStatus().

◆ fastAdd()

void openmsx::DynamicClock::fastAdd ( unsigned n )

inline

Advance this clock by the given number of ticks.

This method is similar to operator+=, but it's optimized for speed. OTOH the amount of ticks should not be too large, otherwise an overflow occurs. Use operator+() when the duration of the ticks approaches 1 second.

Definition at line 180 of file DynamicClock.hh.

Referenced by openmsx::CPUClock::sync().

◆ getFastAdd()

EmuTime openmsx::DynamicClock::getFastAdd ( unsigned n ) const

inline

Definition at line 187 of file DynamicClock.hh.

References add().

Referenced by openmsx::CPUClock::getTimeFast(), and openmsx::CPUClock::getTimeFast().

◆ getFreq()

unsigned openmsx::DynamicClock::getFreq ( ) const

inline

Returns the frequency (in Hz) at which this clock ticks.

See also: setFreq()

Definition at line 128 of file DynamicClock.hh.

References openmsx::MAIN_FREQ.

Referenced by openmsx::CPUClock::getFreq(), openmsx::WavImage::getFrequency(), and openmsx::LaserdiscPlayer::serialize().

◆ getPeriod()

EmuDuration openmsx::DynamicClock::getPeriod ( ) const

inline

Returns the length of one clock-cycle.

Definition at line 135 of file DynamicClock.hh.

Referenced by openmsx::ResampledSoundDevice::createResampler(), openmsx::Autofire::getSignal(), openmsx::ResampleBlip< CHANNELS >::ResampleBlip(), and serialize().

◆ getTicksTill() [1/2]

unsigned openmsx::DynamicClock::getTicksTill ( EmuTime::param e ) const

inline

Calculate the number of ticks for this clock until the given time.

It is not allowed to call this method for a time in the past.

Definition at line 52 of file DynamicClock.hh.

References openmsx::DivModBySame::div().

Referenced by openmsx::Autofire::getSignal(), openmsx::MSXMixer::updateStream(), and openmsx::DACSound16S::writeDAC().

◆ getTicksTill() [2/2]

template<typename FIXED >

void openmsx::DynamicClock::getTicksTill	(	EmuTime::param	e,
		FIXED &	result
	)		const

inline

Definition at line 78 of file DynamicClock.hh.

References openmsx::DivModBySame::div().

◆ getTicksTillAsIntFloat()

IntegralFractional openmsx::DynamicClock::getTicksTillAsIntFloat ( EmuTime::param e ) const

inline

Definition at line 68 of file DynamicClock.hh.

References openmsx::DivModBySame::divMod().

Referenced by openmsx::WavImage::getSampleAt(), and openmsx::YM2413::writePort().

◆ getTicksTillDouble()

double openmsx::DynamicClock::getTicksTillDouble ( EmuTime::param e ) const

inline

Definition at line 93 of file DynamicClock.hh.

◆ getTicksTillUp()

unsigned openmsx::DynamicClock::getTicksTillUp ( EmuTime::param e ) const

inline

Calculate the number of ticks this clock has to tick to reach or go past the given time.

It is not allowed to call this method for a time in the past.

Definition at line 88 of file DynamicClock.hh.

References openmsx::DivModBySame::div().

Referenced by openmsx::CPUClock::advanceHalt(), and openmsx::CPUClock::setLimit().

◆ getTime()

EmuTime::param openmsx::DynamicClock::getTime ( ) const

inline

Gets the time at which the last clock tick occurred.

Definition at line 38 of file DynamicClock.hh.

Referenced by openmsx::ResampledSoundDevice::createResampler(), openmsx::WavImage::getEndTime(), openmsx::CPUClock::getTime(), openmsx::WD2793::peekDTRQ(), and openmsx::MC6850::writeDataReg().

◆ getTotalTicks()

uint64_t openmsx::DynamicClock::getTotalTicks ( ) const

inline

Definition at line 98 of file DynamicClock.hh.

Referenced by openmsx::CPUClock::waitForEvenCycle().

◆ operator+()

EmuTime openmsx::DynamicClock::operator+ ( uint64_t n ) const

inline

Calculate the time at which this clock will have ticked the given number of times (counted from its last tick).

Definition at line 170 of file DynamicClock.hh.

◆ operator+=()

void openmsx::DynamicClock::operator+= ( uint64_t n )

inline

Advance this clock by the given number of ticks.

Definition at line 162 of file DynamicClock.hh.

◆ reset()

void openmsx::DynamicClock::reset ( EmuTime::param e )

inline

Reset the clock to start ticking at the given time.

Definition at line 147 of file DynamicClock.hh.

Referenced by openmsx::ResampledSoundDevice::createResampler(), openmsx::WD2793::getDataReg(), openmsx::MSXMixer::reInit(), openmsx::WD2793::reset(), openmsx::MC6850::reset(), openmsx::TC8566AF::serialize(), openmsx::WD2793::serialize(), openmsx::WD2793::setDataReg(), openmsx::CPUClock::setTime(), and openmsx::MC6850::writeControlReg().

◆ serialize()

template<typename Archive >

void openmsx::DynamicClock::serialize	(	Archive &	ar,
		unsigned	version
	)

Definition at line 8 of file DynamicClock.cc.

References getPeriod(), setFreq(), and setPeriod().

◆ setFreq() [1/2]

void openmsx::DynamicClock::setFreq ( unsigned freq )

inline

Change the frequency at which this clock ticks.

When possible prefer setPeriod() over this method because it may introduce less rounding errors.

Parameters

freq	New frequency in Hertz.

Definition at line 109 of file DynamicClock.hh.

References openmsx::MAIN_FREQ32, and setPeriod().

Referenced by DynamicClock(), openmsx::EmuTimer::EmuTimer(), openmsx::MC6850::reset(), serialize(), openmsx::TC8566AF::serialize(), openmsx::WD2793::serialize(), openmsx::LaserdiscPlayer::serialize(), openmsx::CPUClock::setFreq(), openmsx::WavImage::WavImage(), and openmsx::MC6850::writeControlReg().

◆ setFreq() [2/2]

void openmsx::DynamicClock::setFreq	(	unsigned	freq_num,
		unsigned	freq_denom
	)

inline

Equivalent to setFreq(freq_num / freq_denom), but possibly with less rounding errors.

When possible prefer setPeriod() over this method because it may introduce less rounding errors.

Definition at line 118 of file DynamicClock.hh.

References openmsx::MAIN_FREQ, and setPeriod().

◆ setPeriod()

void openmsx::DynamicClock::setPeriod ( EmuDuration period )

inline

Set the duration of a clock tick.

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ DynamicClock() [1/2]

◆ DynamicClock() [2/2]

Member Function Documentation

◆ add()

◆ advance()

◆ before()

◆ fastAdd()

◆ getFastAdd()

◆ getFreq()

◆ getPeriod()

◆ getTicksTill() [1/2]

◆ getTicksTill() [2/2]

◆ getTicksTillAsIntFloat()

◆ getTicksTillDouble()

◆ getTicksTillUp()

◆ getTime()

◆ getTotalTicks()

◆ operator+()

◆ operator+=()

◆ reset()

◆ serialize()

◆ setFreq() [1/2]

◆ setFreq() [2/2]

◆ setPeriod()