Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

CO Renaming (Pt. 5): Latency Control #12022

Merged
merged 5 commits into from
Sep 29, 2023
Merged

CO Renaming (Pt. 5): Latency Control #12022

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
af76280
refactor(enginemixer): Rename control to `[App],output_latency_ms`
Holzhaus Sep 24, 2023
74b44dc
chore: Use renamed `output_latency_ms` from `[App]` group
Holzhaus Sep 24, 2023
daa5504
fix(controllers): Fix usage of latency control in Akai LPD8-RK mapping
Holzhaus Sep 24, 2023
1248105
test(controlobjectaliastest): Add test for `latency` control alias
Holzhaus Sep 24, 2023
f85acc5
chore: Rename members to match new `output_latency_ms` CO name
Holzhaus Sep 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion res/controllers/Akai-LPD8-RK-scripts.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -493,7 +493,7 @@ LPD8RK.beatjump = function (channel, control, value, status, group) {
var numbeats = LPD8RK.beatjumpstep;
var backseconds = numbeats*(1/(engine.getValue(group, "bpm")/60));
var backsamples = backseconds*engine.getValue(group, "track_samples")/engine.getValue(group, "duration");
var newpos = curpos-(backsamples+engine.getValue("Master", "latency"));
var newpos = curpos-(backsamples+engine.getValue("[App]", "output_latency_ms"));

if (LPD8RK.debug){print("backseconds: "+backseconds);}
if (LPD8RK.debug){print("backsamples: "+backsamples);}
Expand Down
16 changes: 9 additions & 7 deletions src/engine/enginemixer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,15 +74,17 @@ EngineMixer::EngineMixer(
m_pWorkerScheduler->start(QThread::HighPriority);

// Main sample rate
m_pMainSampleRate = new ControlObject(
m_pSampleRate = new ControlObject(
ConfigKey(kAppGroup, QStringLiteral("samplerate")), true, true);
m_pMainSampleRate->addAlias(ConfigKey(group, QStringLiteral("samplerate")));
m_pMainSampleRate->set(44100.);
m_pSampleRate->addAlias(ConfigKey(group, QStringLiteral("samplerate")));
m_pSampleRate->set(44100.);

// Latency control
m_pMainLatency = new ControlObject(ConfigKey(group, "latency"),
m_pOutputLatencyMs = new ControlObject(
ConfigKey(kAppGroup, QStringLiteral("output_latency_ms")),
true,
true); // reported latency (sometimes correct)
m_pOutputLatencyMs->addAlias(ConfigKey(kLegacyGroup, QStringLiteral("latency")));
m_pAudioLatencyOverloadCount = new ControlObject(
ConfigKey(kAppGroup, QStringLiteral("audio_latency_overload_count")));
m_pAudioLatencyOverloadCount->addAlias(ConfigKey(
Expand Down Expand Up @@ -235,8 +237,8 @@ EngineMixer::~EngineMixer() {
delete m_pXFaderMode;

delete m_pEngineSync;
delete m_pMainSampleRate;
delete m_pMainLatency;
delete m_pSampleRate;
delete m_pOutputLatencyMs;
delete m_pAudioLatencyOverloadCount;
delete m_pAudioLatencyUsage;
delete m_pAudioLatencyOverload;
Expand Down Expand Up @@ -417,7 +419,7 @@ void EngineMixer::process(const int iBufferSize) {
bool boothEnabled = m_pBoothEnabled->toBool();
bool headphoneEnabled = m_pHeadphoneEnabled->toBool();

m_sampleRate = mixxx::audio::SampleRate::fromDouble(m_pMainSampleRate->get());
m_sampleRate = mixxx::audio::SampleRate::fromDouble(m_pSampleRate->get());
// TODO: remove assumption of stereo buffer
constexpr unsigned int kChannels = 2;
const unsigned int iFrames = iBufferSize / kChannels;
Expand Down
4 changes: 2 additions & 2 deletions src/engine/enginemixer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,8 +303,8 @@ class EngineMixer : public QObject, public AudioSource {
ControlObject* m_pMainGain;
ControlObject* m_pBoothGain;
ControlObject* m_pHeadGain;
ControlObject* m_pMainSampleRate;
ControlObject* m_pMainLatency;
ControlObject* m_pSampleRate;
ControlObject* m_pOutputLatencyMs;
ControlObject* m_pAudioLatencyOverloadCount;
ControlObject* m_pAudioLatencyUsage;
ControlObject* m_pAudioLatencyOverload;
Expand Down
6 changes: 3 additions & 3 deletions src/preferences/dialog/dlgprefsound.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,8 +207,8 @@ DlgPrefSound::DlgPrefSound(QWidget* pParent,
new ControlProxy(kAppGroup, QStringLiteral("audio_latency_overload_count"), this);
m_pAudioLatencyOverloadCount->connectValueChanged(this, &DlgPrefSound::bufferUnderflow);

m_pMainLatency = new ControlProxy("[Master]", "latency", this);
m_pMainLatency->connectValueChanged(this, &DlgPrefSound::mainLatencyChanged);
m_pOutputLatencyMs = new ControlProxy(kAppGroup, QStringLiteral("output_latency_ms"), this);
m_pOutputLatencyMs->connectValueChanged(this, &DlgPrefSound::outputLatencyChanged);

// TODO: remove this option by automatically disabling/enabling the main mix
// when recording, broadcasting, headphone, and main outputs are enabled/disabled
Expand Down Expand Up @@ -732,7 +732,7 @@ void DlgPrefSound::bufferUnderflow(double count) {
update();
}

void DlgPrefSound::mainLatencyChanged(double latency) {
void DlgPrefSound::outputLatencyChanged(double latency) {
currentLatency->setText(QString("%1 ms").arg(latency));
update();
}
Expand Down
4 changes: 2 additions & 2 deletions src/preferences/dialog/dlgprefsound.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ class DlgPrefSound : public DlgPreferencePage, public Ui::DlgPrefSoundDlg {
void slotApply() override; // called on ok button
void slotResetToDefaults() override;
void bufferUnderflow(double count);
void mainLatencyChanged(double latency);
void outputLatencyChanged(double latency);
void latencyCompensationSpinboxChanged(double value);
void mainDelaySpinboxChanged(double value);
void headDelaySpinboxChanged(double value);
Expand Down Expand Up @@ -86,7 +86,7 @@ class DlgPrefSound : public DlgPreferencePage, public Ui::DlgPrefSoundDlg {
UserSettingsPointer m_pSettings;
SoundManagerConfig m_config;
ControlProxy* m_pAudioLatencyOverloadCount;
ControlProxy* m_pMainLatency;
ControlProxy* m_pOutputLatencyMs;
ControlProxy* m_pHeadDelay;
ControlProxy* m_pMainDelay;
ControlProxy* m_pBoothDelay;
Expand Down
2 changes: 1 addition & 1 deletion src/soundio/sounddevicenetwork.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ SoundDeviceStatus SoundDeviceNetwork::open(bool isClkRefDevice, int syncBuffers)

// Update the samplerate and latency ControlObjects, which allow the
// waveform view to properly correct for the latency.
ControlObject::set(ConfigKey("[Master]", "latency"),
ControlObject::set(ConfigKey(kAppGroup, QStringLiteral("output_latency_ms")),
requestedBufferTime.toDoubleMillis());
ControlObject::set(ConfigKey(kAppGroup, QStringLiteral("samplerate")), m_dSampleRate);

Expand Down
4 changes: 3 additions & 1 deletion src/soundio/sounddeviceportaudio.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,9 @@ SoundDeviceStatus SoundDevicePortAudio::open(bool isClkRefDevice, int syncBuffer
if (isClkRefDevice) {
// Update the samplerate and latency ControlObjects, which allow the
// waveform view to properly correct for the latency.
ControlObject::set(ConfigKey("[Master]", "latency"), currentLatencyMSec);
ControlObject::set(
ConfigKey(kAppGroup, QStringLiteral("output_latency_ms")),
currentLatencyMSec);
ControlObject::set(ConfigKey(kAppGroup, QStringLiteral("samplerate")), m_dSampleRate);
m_invalidTimeInfoCount = 0;
m_clkRefTimer.start();
Expand Down
2 changes: 1 addition & 1 deletion src/test/co_dumps/co_dump_inital.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
[EffectRack1_EffectUnit4_Effect4],parameter4_set_default,0
[EffectRack1_EffectUnit2_Effect2],parameter2_link_type,0
[QuickEffectRack1_[Channel3]_Effect1],parameter5_set_zero,0
[Master],latency,5.80499
[App],output_latency_ms,5.80499
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My dump button is broken. Does yours work? I will file a bug.

Copy link
Member Author

@Holzhaus Holzhaus Sep 29, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My dump button is broken. Does yours work? I will file a bug.

Last time it check it did. It creates a file in ~/.mixxx. It does not create a save file dialog.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, right it is working. I just needed to look in my testing .mixxx folder 🤦

[Channel4],hotcue_15_enabled,0
[Channel4],hotcue_2_activate,0
[EffectRack1_EffectUnit3_Effect3],parameter4_minus_toggle,0
Expand Down
4 changes: 4 additions & 0 deletions src/test/controlobjectaliastest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,10 @@ TEST_F(ControlObjectAliasTest, EngineMixer) {
auto sampleRateLegacy = ControlProxy(ConfigKey(kLegacyGroup, QStringLiteral("samplerate")));
EXPECT_DOUBLE_EQ(sampleRate.get(), sampleRateLegacy.get());

auto latency = ControlProxy(ConfigKey(kAppGroup, QStringLiteral("output_latency_ms")));
auto latencyLegacy = ControlProxy(ConfigKey(kLegacyGroup, QStringLiteral("latency")));
EXPECT_DOUBLE_EQ(latency.get(), latencyLegacy.get());

auto audioLatencyUsage = ControlProxy(
ConfigKey(kAppGroup, QStringLiteral("audio_latency_usage")));
auto audioLatencyUsageLegacy = ControlProxy(
Expand Down
2 changes: 1 addition & 1 deletion src/vinylcontrol/vinylcontrolxwax.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ VinylControlXwax::VinylControlXwax(UserSettingsPointer pConfig, const QString& g
}

double latency = ControlObject::get(
ConfigKey("[Master]", "latency"));
ConfigKey(QStringLiteral("[App]"), QStringLiteral("output_latency_ms")));
if (latency <= 0 || latency > 200) {
qDebug() << "Failed to get sane latency, assuming 20 as a reasonable value";
latency = 20;
Expand Down
Loading