Per track meter internals #5830

Paul-Licameli · 2023-12-30T17:15:46Z

Resolves: (direct link to the issue)

Depends on

Master channel #6442

Some of this originated in #5779

Put into AudioIO.cpp all the support needed for per-track meters displaying correct peak and RMS data
(post all adjustments for the effect stack, pan, gain, envelope).

But also other cleanups of AudioIO. Move the experimental automated input level adjustment out, so the Meter
interface needs fewer virtual functions.

Also clean up the publication of events from AudioIO and correct some non-thread-safe message callbacks.

To do: MixerBoard should use this. It doesn't show correct data now in all cases. See #5117

(short description of the changes and the motivation to make the changes)

I signed CLA
The title of the pull request describes an issue it addresses
If changes are extensive, then there is a sequence of easily reviewable commits
Each commit's message describes its purpose and effects
There are no behavior changes unnecessary for the stated purpose of the PR

Recommended:

Each commit compiles and runs on my machine without known undesirable changes of behavior

crsib · 2024-01-16T09:40:18Z

src/widgets/MeterPanel.cpp

@@ -1126,8 +1126,8 @@ void MeterPanel::OnMeterUpdate(wxTimerEvent & WXUNUSED(event))

   if (numChanges > 0) {
      #ifdef EXPERIMENTAL_AUTOMATED_INPUT_LEVEL_ADJUSTMENT
-         if (gAudioIO->AILAIsActive() && mIsInput && !discarded) {
-            gAudioIO->AILAProcess(maxPeak);
+         if (AudioIO::Get()->AILAIsActive() && mIsInput && !discarded) {


It seems that the only place EXPERIMENTAL_AUTOMATED_INPUT_LEVEL_ADJUSTMENT should be used in such approach is AILAIsActive.

crsib · 2024-01-16T09:42:35Z

src/widgets/MeterPanel.cpp

-         if (gAudioIO->AILAIsActive() && mIsInput && !discarded) {
-            gAudioIO->AILAProcess(maxPeak);
+         if (AudioIO::Get()->AILAIsActive() && mIsInput && !discarded) {
+            AudioIO::Get()->AILAProcess(maxPeak);
            putchar('\n');


But this code is disturbing. Why is it here?

This transformation is not quite conservative anyway, so probably this line should be removed?

It seems that AILA logs extensively, probably way to extensively. Is it ready for use at all?

crsib · 2024-01-16T09:51:51Z

src/widgets/MeterPanel.cpp

-      gAudioIO->GetMixer(&inputSource, &inputVolume, &outputVolume);
-
+      auto settings = gAudioIO->GetMixer();
+      auto &[inputSource, inputVolume, outputVolume] = settings;


I think the code would be much more readable without this line.

crsib · 2024-01-16T09:53:56Z

libraries/lib-audio-io/AudioIO.cpp

@@ -2376,7 +2377,9 @@ void AudioIO::AILAProcess(double maxPeak) {

         putchar('\n');
         mAILAMax = pInputMeter ? ToLinearIfDB(mAILAMax, pInputMeter->GetDBRange()) : 0.0;
-         double iv = (double) Px_GetInputVolume(mPortMixer);
+         auto settings = audioIO.GetMixer();
+         auto &[_, inputVolume, __] = settings;


Again, why?

crsib · 2024-01-16T09:57:28Z

libraries/lib-audio-io/AudioIO.cpp

-               wxPrintf("\tnew vol:%f\n", vol);
-               float check = Px_GetInputVolume(mPortMixer);
+               wxPrintf("\tnew vol:%f\n", inputVolume);
+               auto [_, check, __] = audioIO.GetMixer();


This one is the weirdest case of structured binding use so far.

crsib · 2024-01-16T10:02:54Z

libraries/lib-audio-io/AudioIO.cpp

 }

 double AudioIO::AILAGetLastDecisionTime() {
   return mAILAAnalysisEndTime;
 }

+double AudioIO::GetClockTime() const {


GetStreamTime returns stream time specific to Audacity, GetClockTime - actual stream time. Quite confusing, and I don't understand why is it called "clock" time.

crsib · 2024-01-16T10:34:57Z

libraries/lib-audio-io/AudioIO.cpp

 AudioIO::AudioIO()
 {
+   wxTimer::Start(kTimerInterval.count());


There is no safety around what kind of duration the kTimerInterval will be. Explicit duration_cast<milliseconds> would help.

Paul-Licameli · 2024-01-16T12:12:22Z

I should have put the big red Experimental label on this bit of holiday hackathon. I didn't ask review yet, but thank you.

Paul-Licameli · 2024-05-08T15:47:39Z

@saintmatthieu @vsverchinsky

Rebased onto latest master.

There is much cleanup of AudioIO.cpp that I prepared. It's still not all of the cleanup.

Correct inter-thread communication of the stream of most recently played samples is necessary for a per-track meter display that is not meaningless garbage.

... Don't emit start events until success is known. Only ProjectAudioManager cared, and anyway ignored start events.

Paul-Licameli added the refactoring Pull request that restructures code but is not intended to make any observable changes of behavior label Dec 30, 2023

Paul-Licameli requested a review from crsib December 30, 2023 17:15

Paul-Licameli force-pushed the Per-track-meter-internals branch 2 times, most recently from 2271159 to f4680c4 Compare January 2, 2024 01:43

Paul-Licameli force-pushed the Per-track-meter-internals branch 8 times, most recently from 4cf0c82 to 7780a46 Compare January 12, 2024 10:56

crsib reviewed Jan 16, 2024

View reviewed changes

Paul-Licameli added the Experimental Exploratory, proof-of-concept PRs, never to me merged label Jan 16, 2024

Paul-Licameli force-pushed the Per-track-meter-internals branch from 7780a46 to e3313e1 Compare May 8, 2024 15:43

Paul-Licameli force-pushed the Per-track-meter-internals branch from e3313e1 to e52daee Compare May 13, 2024 13:53

Paul-Licameli force-pushed the Per-track-meter-internals branch 5 times, most recently from 49f32f5 to afbf2f6 Compare June 2, 2024 19:43

Paul-Licameli mentioned this pull request Jun 2, 2024

Per track meters #5861

Open

6 tasks

Paul-Licameli added 28 commits June 4, 2024 09:12

Replicate AudioIO.* in AILA.*

1c18354

Move AILA to new files

54aa704

Shorten member variable names

f8c90f8

Register the menu item to turn AILA on and off, and use BoolSetting

cd44824

Menu item name convention; see commit 4ec4293

47cd869

More Settings objects in AILA

343011e

Prepare to add types to AudioIOEvent

a9e44eb

Call ProjectAudioManager callbacks only on the main thread

6eee57f

Unify two forms of publishing from AudioIO; remove AudioIOListener

90b8a3f

Unify "Capture" and "Recording" events...

7e698a1

... Don't emit start events until success is known. Only ProjectAudioManager cared, and anyway ignored start events.

Move AudioIOBase::mRate to AudioIoCallback

cb4b6ba

Support for multiple input and output Meter objects

ae774b0

TransportSequences can point to abstract playback meter objects

ccbb9af

A global hook associates meters with tracks

397543f

Meters can accept interleaved data, or non-; clean up MeterPanel.cpp

4eafb24

Communicate data to per-track meters

8d168ff

Change some pointer arguments to references in MeterPanel

dec7db3

Remove unused member of MeterBar

0d956a7

A member fuction and initializers in MeterBar

83514f1

Separate MeterBar from MeterPanel::Stats

4995501

Remove pure virtuals from MeterPanelBase

29b4a4a

Separate PeakAndRmsMeter as a base class of MeterPanel

45dc358

Lower more processing into PeakAndRmsMeter

ed9208e

Lift the AILA processing up again

a57ba6d

Replicate MeterPanel.* in PeakAndRmsMeter.*

c4e90ff

Move PeakAndRmsMeter to new files

596fd6f

Remove dead code

53ef201

Complete the cleanup from commit f3d819d

f0cfee7

Paul-Licameli force-pushed the Per-track-meter-internals branch 2 times, most recently from 5351389 to f0cfee7 Compare June 4, 2024 13:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Per track meter internals #5830

Per track meter internals #5830

Paul-Licameli commented Dec 30, 2023 •

edited

crsib Jan 16, 2024

crsib Jan 16, 2024

crsib Jan 16, 2024

crsib Jan 16, 2024

crsib Jan 16, 2024

crsib Jan 16, 2024

crsib Jan 16, 2024

Paul-Licameli commented Jan 16, 2024

Paul-Licameli commented May 8, 2024

Per track meter internals #5830

Are you sure you want to change the base?

Per track meter internals #5830

Conversation

Paul-Licameli commented Dec 30, 2023 • edited

crsib Jan 16, 2024

Choose a reason for hiding this comment

crsib Jan 16, 2024

Choose a reason for hiding this comment

crsib Jan 16, 2024

Choose a reason for hiding this comment

crsib Jan 16, 2024

Choose a reason for hiding this comment

crsib Jan 16, 2024

Choose a reason for hiding this comment

crsib Jan 16, 2024

Choose a reason for hiding this comment

crsib Jan 16, 2024

Choose a reason for hiding this comment

Paul-Licameli commented Jan 16, 2024

Paul-Licameli commented May 8, 2024

Paul-Licameli commented Dec 30, 2023 •

edited