Skip to content

Commit

Permalink
Updated comments for clarity (original commited bei xeruf in macro_co…
Browse files Browse the repository at this point in the history
…ntrols)
  • Loading branch information
JoergAtGithub committed Oct 31, 2024
1 parent edae0ca commit 29c627b
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions src/engine/controls/enginecontrol.h
Original file line number Diff line number Diff line change
Expand Up @@ -48,17 +48,17 @@ class EngineControl : public QObject {
UserSettingsPointer pConfig);
~EngineControl() override;

// Called by EngineBuffer::process every latency period. See the above
// comments for information about guarantees that hold during this call. An
// EngineControl can perform any upkeep operations that are necessary during
// this call.
/// Called by EngineBuffer::process every latency period.
/// See the above comments for information about guarantees that hold during this call.
/// An EngineControl can perform any upkeep operations necessary here.
/// @param dRate current playback rate in audio frames per second
virtual void process(const double dRate,
mixxx::audio::FramePos currentPosition,
const int iBufferSize);

// hintReader allows the EngineControl to provide hints to the reader to
// indicate that the given portion of a song is a potential imminent seek
// target.
/// hintReader allows the EngineControl to provide hints to the reader
/// to indicate that the given portion of a song
/// is a potential imminent seek target.
virtual void hintReader(gsl::not_null<HintVector*> pHintList);

virtual void setEngineMixer(EngineMixer* pEngineMixer);
Expand All @@ -73,7 +73,7 @@ class EngineControl : public QObject {
mixxx::audio::FramePos endPosition,
bool enabled);

// Called to collect player features for effects processing.
/// Collect player features for effects processing.
virtual void collectFeatureState(GroupFeatureState* pGroupFeatures) const {
Q_UNUSED(pGroupFeatures);
}
Expand Down Expand Up @@ -103,9 +103,10 @@ class EngineControl : public QObject {
}
void seek(double fractionalPosition);
void seekAbs(mixxx::audio::FramePos position);
// Seek to an exact sample and don't allow quantizing adjustment.
void seekExact(mixxx::audio::FramePos position);
// Returns an EngineBuffer to target for syncing. Returns nullptr if none found
/// Seek to an exact frame, no quantizing
/// virtual only for tests!
virtual void seekExact(mixxx::audio::FramePos position);
/// Return an EngineBuffer to target for syncing. Returns nullptr if none found.
EngineBuffer* pickSyncTarget();

UserSettingsPointer getConfig();
Expand Down

0 comments on commit 29c627b

Please sign in to comment.