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

Audacity Bugzilla



Bug 2042 - Some plug-ins show "Debug" buttons
Some plug-ins show "Debug" buttons
Status: NEW
Product: Audacity
Classification: Unclassified
Component: User Interface
2.3.0
Per OS All
: P4 RepeatableAll
Assigned To: Default Assignee for New Bugs
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2018-11-30 11:14 UTC by Peter Sampson
Modified: 2021-01-30 14:44 UTC (History)
6 users (show)

See Also:
Steps To Reproduce:
1. Effect > Vocal Reduction and Isolation
Release Note:
First Git SHA:
Group: ---
Workaround:
Closed:


Attachments
Example of a specious empty debug diLOG BOX (33.79 KB, image/png)
2018-11-30 11:14 UTC, Peter Sampson
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Peter Sampson 2018-11-30 11:14:09 UTC
Created attachment 796 [details]
Example of a specious empty debug diLOG BOX

The following plugin EGATs still have Debug buttons showing

Sound Finder‎ 
Silence Finder‎ 
Sample Data Import‎ 
Vocal Reduction and Isolation‎ 
Spectral edit shelves‎ 
Spectral edit parametric EQ‎ 
Risset Drum‎ 
Rhythm Track‎ 
Beat Finder‎ 
Vocoder‎
Vocal Remover‎ 
Clip Fix
Nyquist Prompt

Debug messages and debug buttons should not be visible to users in released versions of the application or in RCs.

It is fine to have them in alpha test when the plug-in is under test and debugging is required - but for release they should be removed or commented out (and replaced if necessary for the nxt development debug cycle.

Of those listed, the only one to excuse itself at all is Clip fix where it staes in an ednote
>Steve by email 23May17: ToDo ClipFix needs some attention. 
>It has a known bug #1618 and an outstanding "feature request" 
>to handle "inverted peaks". 
>Hence the retention of the Debug button.

I assume that the others are by now fully-tested and thus no longer requiring debugging - else they should not be released.

Also note that in most cases pressing the debug button produces a specious empty debug dialog box - see attachment for an example
Comment 1 Steve Daulton 2018-11-30 11:48:41 UTC
This is not really a bug.

The Nyquist Prompt is a special case. It is used with user supplied code, which will often be "experimental", so it is totally appropriate for it to always have a debug button.

Some Nyquist plug-ins have been updated in the recent past and I have sufficient confidence of them being "bug free" that I have hidden the Debug button.

Nyquist effects that still have a Debug button are mostly ancient code. For one reason or another, no-one has deemed them to be sufficiently "final" to warrant hiding the Debug button.

I'm happy for this to be logged as an open issue, as it serves as a reminder that some of the shipped Nyquist effects need to be updated and rigorously tested.

I would not be comfortable hiding the Debug button without first checking that these effects meet current standards. (They should all be version 4 plug-ins, and should make use of modern plug-in features where appropriate).

> Also note that in most cases pressing the debug button produces a 
> specious empty debug dialog box.

There's really nothing "specious" about the debug dialog being empty. It confirms that with the current user settings, no errors were found.


> I assume that the others are by now fully-tested and thus no longer
> requiring debugging - else they should not be released.

I think we can have high confidence that they essentially "work as described"(fit for purpose / not "buggy"), but I have low confidence that they all meet current coding standards, make appropriate use of modern features, and are as efficient and user friendly as they could be - in short, they "probably" need some TLC.
Comment 2 Steve Daulton 2018-11-30 11:54:29 UTC
A revised list of plug-ins in need of attention:

Sound Finder‎ 
Silence Finder‎ 
Sample Data Import‎ 
Vocal Reduction and Isolation‎ 
Spectral edit shelves‎ 
Spectral edit parametric EQ‎ 
Risset Drum‎ 
Rhythm Track‎ 
Beat Finder‎ 
Vocoder‎
Vocal Remover‎ 
Clip Fix

* Regular Interval Labels

Although "RIL" does not currently have a Debug button, I think it should be rewritten as a Nyquist Macro. After that has been done, it may be appropriate to retain the Debug button for a while as the Nyquist Macro code is still under development.
Comment 3 Steve Daulton 2021-01-30 14:44:02 UTC
Revised list as of Audacity 3.0.0 7aa264:

Sample Data Import
Sample Data Export
Vocal Reduction and Isolation
Spectral edit shelves
Spectral edit parametric EQ
Risset Drum
Rhythm Track
Beat Finder
Vocoder
Clip Fix