Audacity Bug Summary
••• Introduction •••
••• Keywords •••
    Audacity 3.0.3 development began 19th April 2021

Audacity Bugzilla



Bug 2431 - Real-time effects - Enable checkbox has no effect
Real-time effects - Enable checkbox has no effect
Status: RESOLVED FIXED
Product: Audacity
Classification: Unclassified
Component: Application Core
2.4.0
Per OS All
: P2 Repeatable
Assigned To: Paul L
:
: 2454 (view as bug list)
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2020-05-12 07:42 UTC by Peter Sampson
Modified: 2020-06-08 09:03 UTC (History)
7 users (show)

See Also:
Steps To Reproduce:
1) Import or generate some audio. 2) Select an AU effect (I used AUDistortion for clarity) 3) Click preview button 4) Observe: effect preview is applied 5) Uncheck Enable button 6) Observe: effect is not disabled
Release Note:
On Mac when using AU effects the "Enable" checkbox has no effect.
First Git SHA:
Group: ---
Workaround:
None
Closed: 2020-06-08 00:00:00
petersampsonaudacity: Regression+
petersampsonaudacity: Test‑OK‑Win+
petersampsonaudacity: Test‑OK‑Mac+


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Peter Sampson 2020-05-12 07:42:12 UTC
This is a regression on 2.3.2 reported by Bill via email

He wrote there
>Problem exists in Generic and Full interfaces.
>VST and built-in effects, Enable checkbox works properly.
>As far as I know no-one has complained about this in 2.3.3.

>Testing 2.4.0 rc06 on iMac 10.14.5 and Macbook Air 10.15.4.

I confirm his findings on my MacBook Pro with Catalina 10.15.4
Comment 1 Bill Wharrie 2020-05-21 17:17:49 UTC
In 2.4.1 on macOS 10.14.5, the Enable checkbox does not work on built-in effects, nor on VST effects.
Upping this to P2 as I hope it can get fixed for 2.4.2.
Comment 2 Leland Lucius 2020-05-25 19:29:47 UTC
Fix committed in:

https://github.com/audacity/audacity/commit/5e8cfb0
Comment 3 Bill Wharrie 2020-05-25 20:58:58 UTC
Fixed for AU effects. For built-in effects and VST effects the enable checkbox is still non-functional. Tested on commit 0ef7213, macOS 10.14.5
Comment 4 Leland Lucius 2020-05-25 21:08:57 UTC
(In reply to Bill Wharrie from comment #3)
> Fixed for AU effects. For built-in effects and VST effects the enable
> checkbox is still non-functional. Tested on commit 0ef7213, macOS 10.14.5

Sorry Bill, I misunderstood. I thought it was only AU on the Mac.  I think the VST issue is a bit more widespread since I can't get it to work on Windows either.  Haven't tried Linux yet.  Nor have I tried built-in, but I suspect if we fix the VST issue, we'll also fix the built-in fellas.
Comment 5 Leland Lucius 2020-05-26 00:13:36 UTC
(In reply to Leland Lucius from comment #4)
> (In reply to Bill Wharrie from comment #3)
> > Fixed for AU effects. For built-in effects and VST effects the enable
> > checkbox is still non-functional. Tested on commit 0ef7213, macOS 10.14.5
> 
> Sorry Bill, I misunderstood. I thought it was only AU on the Mac.  I think
> the VST issue is a bit more widespread since I can't get it to work on
> Windows either.  Haven't tried Linux yet.  Nor have I tried built-in, but I
> suspect if we fix the VST issue, we'll also fix the built-in fellas.

Looks like this was caused by:

  commit 867e6a8d9e67288c5dec3e0753aeae7f0f63f5df (refs/bisect/bad)
  Author: Paul Licameli <paul.licameli@audacityteam.org>
  Date:   Sun Jun 23 19:23:18 2019 -0400

      Move fields out of Effect, into new class RealtimeEffectState...

      ... and simplify, using a std::atomic instead of a critical section.

      (But did this before, and does this now, correctly synchronize across threads?
      I defer that question.)

Researching a resolution.
Comment 6 Leland Lucius 2020-05-26 01:05:25 UTC
I know the reason now, but am unsure of the resolution.  The suspend state for each effect was decoupled from the effect so when the user clicks the Enabled checkbox, the actual effect plugin is notified, but IsRealtimeState() has no idea that anything has happened.
Comment 7 Paul L 2020-05-29 20:36:10 UTC
Thanks for bisecting.  Shame on me.  Fix soon.
Comment 9 Bill Wharrie 2020-05-29 21:36:38 UTC
(In reply to Paul L from comment #8)
AU, VST and built-in effects now respond to the Enable checkbox. macOS 10.14.5. 

Thanks, guys.
Comment 10 Peter Sampson 2020-05-30 05:56:55 UTC
Tested om W10 with Audacity 2.4.0 3646bb8

Tested with built-in and VST effects - all now respond to the Enable checkbox.

Marked as OK on Mac too on the basis of Bill's test.
Comment 11 Peter Sampson 2020-05-31 07:04:31 UTC
*** Bug 2454 has been marked as a duplicate of this bug. ***
Comment 12 Steve Daulton 2020-06-07 11:40:50 UTC
Should the "Enable" checkbox only affect the preview, or should is also affect "Apply"?

Testing on Linux, the "Enable" checkbox correctly enables / disables the effect preview, but on clicking the "Apply" button, the effect is applied even if the "Enable" checkbox is not selected.

The manual seems to imply that when the "Enable" checkbox is not selected, the effect should be "dry". If the behaviour that I describe is the expected "correct" behaviour, then I think the manual needs some clarification.
Comment 13 Peter Sampson 2020-06-07 12:35:11 UTC
My understanding is that the Enable checkbox is a preview tool and affects:

a) playback when in the RTP effect
b) Playback in Audacity while the RTP is open

And "Apply" always applies regardless of whether the Enable is checke on or not.


Does anybody disagree tthat this is intended, desired, behavior ?

I will have a look at the Manual in the next couple of days to see if I can make it clearer.
Comment 14 Peter Sampson 2020-06-08 09:03:13 UTC
(In reply to Peter Sampson from comment #13)
I updated the template that drives the buttons (WahWah here as an example - one of four RTP effects):
https://alphamanual.audacityteam.org/man/Wahwah#Buttons

And I updated the RTP page:
https://alphamanual.audacityteam.org/man/Real-time_preview_of_effects#Real-Time_preview_with_graphical_interface