Difference between revisions of "Macros discussion page"

From Audacity Wiki
Jump to: navigation, search
m (Buttons to apply to project and files)
(Sorting.)
Line 9: Line 9:
 
* {{todo}} (Aspirational) Find-command entry box in Select Command dialog.
 
* {{todo}} (Aspirational) Find-command entry box in Select Command dialog.
 
* {{done}} Custom names for {{button|All}} {{button|None}} etc.
 
* {{done}} Custom names for {{button|All}} {{button|None}} etc.
 +
* {{todo}} Persistent settings for export-as
 +
 +
===Enhancement Requests===
 +
* {{todo}} More flexibility on export formats.
 +
** Export as M4A(AAC) and AIFF
 +
* {{todo}} More flexibility on export file names
 +
** Prompt for output directory
 +
** Prefix and suffix control for file names.
 +
* {{todo}} Avoid file overwrite on apply-to-project or apply-to-files.
 +
** OPTION: Prompt with OK/NO
 +
** OPTION: Automatically include a number.
 +
* {{todo}} Warn if no export step in an export-files chain.
 +
* {{todo}} Message to gain a pause option, so can be used as breakpoint.
 +
** The 'real' work here is making messages appear during processing, not at the end, as they are buffered up for display.
 +
  
 
==Bugs==
 
==Bugs==
{{#bugzilla:
 
|id=1854,1807,1793,1745,1742,1709,1238,1237,901,878,876,628,549,548,526,294
 
|disablecache=1
 
|columns=id,priority,status,summary,id
 
}}
 
  
==Mac crash on second evocation of Tools > Macro==
 
I don't think this is yet logged on Bugzilla
 
  
 +
===Bug (untracked) - Mac crash on second invocation of Tools > Macro===
 
A second related instance is reported on the Forum  [https://forum.audacityteam.org/viewtopic.php?f=68&t=99358 Bug: Audacity 2.3.0 crashes on second entry to Manage Macros]
 
A second related instance is reported on the Forum  [https://forum.audacityteam.org/viewtopic.php?f=68&t=99358 Bug: Audacity 2.3.0 crashes on second entry to Manage Macros]
  
==Regression testing Macros versus Chains==
+
===Bug (untracked) - Nested "cleaned" folders===
As outlined in recent email on Quality - germane points to be summarized here.
+
Not only do we get the regression of interrupting the automated process with requests for user input - we also get the bug of the nested "cleaned" folders.  This bug is not yet logged on Bugzilla pending discussions on desired behaviors.
 +
 
 +
===Bug 1854 - Un-warned export file overwrite danger in 2.2.2 Chains===
 +
*P3 [https://bugzilla.audacityteam.org/show_bug.cgi?id=1854 Bug #1854]
 +
Apply Chain can silently overwrite an existing file of the same name in the "cleaned" folder - and this is done with no warning to the user (as one would normally expect with potential file over-writes.
 +
 
 +
The current behavior of 2.3.0 alpha Macros side-steps this issue with its user interrupts for file locations - and goes on to issue an overwrite warning if the user does not change the filename - but the overwrite is allowable of course.  The current 2.3.0 is probably a regression (discussed elsewhere) - hence this bug stands.
 +
 
 +
===Bug (untracked) - Mac: typing a command name does not cause the command-list scroller to display the command===
 +
Bill: In the “Select Command” dialog (which is invoked by the “Insert” button in the Manage Macros dialog), it is possible to type some characters and have a command show up in the “Command” text display box. It would be nice if the scroller would update to show that command in the list.
 +
 
 +
For example, if I’m looking for the “Mix and Render” command, I could type “m”, and the scroller would update to show the “MP3 Conversion” command, highlighted, in the (middle of?) the dialog. I could then see the “Mix and Render” command and click on it, or see to arrow down to it, or repeatedly type “m” to move to the next command starting with “m” (same as arrow down, except “m” goes back to “MP3 Conversion” after reaching “Move to Previous Label”).
 +
 
 +
Currently, typing “m” followed by down-arrow (or up-arrow) updates the scroller, but typing “m” twice does not.
  
Macros and Chains behave differently on Export
+
* [[User:James|James]] ([[User talk:James|talk]]) Mac only, it seems.  Will have a look when I am on that platform.
  
We need to decide what is desired-behavior on Export from Macros.
 
  
===Bug: nested "cleaned" folders===
 
Not only do we get the regression of interrupting the automated process with requests for user input - we also get the bug of the nested "cleaned" folders.  This bug is not yet logged on Bugzilla pending discussions on desired behaviors.
 
  
==Export as M4A(AAC) and AIFF==
+
----
These commands to be added to the available commands for Macros.
 
  
==Parameter setting for "Export as ..." in Macros==
+
===Bug list===
There is no ability to set parameters for the "Export as ..." commands in Chains
 
  
'''Bill wrote:'''  I seem to recall we’ve been bitten by the “use the last settings made by the user for this command” before. That is, the user sets up a chain containing an effect, later uses the effect with new settings, then finds that the chain uses these new settings rather than the ones in effect when the chain was created/edited. I think it is much safer to explicitly save the settings in the macro step.
+
{{#bugzilla:
 +
|id=1854,1807,1793,1745,1742,1709,1238,1237,901,878,876,628,549,548,526,294
 +
|disablecache=1
 +
|columns=id,priority,status,summary,id
 +
}}
  
Bill also supports a dialog, similar to the Export Multiple dialog, the comes up before any macro invoked by the Apply to files button, that allows the user to at least set the export folder. I'd like the user to also be able to alter the filenames of the exported files, for instance by adding a prefix or suffix.
 
  
==Persistence of Manage Macros and Macros Palette dialogs==
 
James has fixed this  so that the Manage Macros and Macros Palette dialogs remain on-screen while a Macro is being applied to the current project.
 
  
The Manage Macros and Macros Palette dialogs are temporarily removed from the screen while a Macro is being applied to a file,
+
==Regression testing Macros versus Chains==
 +
As outlined in recent email on Quality - germane points to be summarized here.
  
These are desired and intended behaviors
+
Macros and Chains behave differently on Export
  
==Bug 1854 - Un-warned export file overwrite danger in 2.2.2 Chains==
+
We need to decide what is desired-behavior on Export from Macros.
*P3 [https://bugzilla.audacityteam.org/show_bug.cgi?id=1854 Bug #1854]
 
Apply Chain can silently overwrite an existing file of the same name in the "cleaned" folder - and this is done with no warning to the user (as one would normally expect with potential file over-writes.
 
  
The current behavior of 2.3.0 alpha Macros side-steps this issue with its user interrupts for file locations - and goes on to issue an overwrite warning if the user does not change the filename - but the overwrite is allowable of course.  The current 2.3.0 is probably a regression (discussed elsewhere) - hence this bug stands.
 
  
=="Cleaned" versus "cleaned" folder name==
+
==Wording - "Cleaned" versus "cleaned" folder name==
 
Peter (and Connie) would prefer the "cleaned" folder to be capitalized - or Peter would prefer it be renamed to "Macro Output"
 
Peter (and Connie) would prefer the "cleaned" folder to be capitalized - or Peter would prefer it be renamed to "Macro Output"
 
Bill would prefer the user to be prompted for the export folder. See above ''Parameter setting for "Export as ..." in Macros''
 
Bill would prefer the user to be prompted for the export folder. See above ''Parameter setting for "Export as ..." in Macros''
  
==No export in Macros for files==
 
Bill has proposed, that since it makes no sense to run a Macro on a file  where the Macro does not have a export step, we block running a Macro on file(s) if the Macro has no Export step.  Peter supports this.
 
 
==Macros file overwrites==
 
Any potential file overwrite by a Macro either applied top project or to file(s) should issue a warning to the user and pause for OK/NO before proceeding.
 
  
 
==Renaming macros==
 
==Renaming macros==
 
Bill: Given that a macro can be called from another macro, is it not dangerous to allow macros to be renamed?
 
Bill: Given that a macro can be called from another macro, is it not dangerous to allow macros to be renamed?
  
==Bug? Message step does not pause macro==
+
* [[User:James|James]] ([[User talk:James|talk]]) No, not dangerous.
Bill: It seems one of the uses of this step would be to debug a macro. Having it pause the macro with Cancel and Continue buttons would be helpful in that instance. It might also be useful for getting confirmation from the user.
+
 
  
 
==Should a macro be able to call itself, and what does it mean if it does?==
 
==Should a macro be able to call itself, and what does it mean if it does?==
 
Bill: It is possible to insert a step that is the macro you are editing. For example, edit the supplied “Fade Ends” macro by inserting the “Fade Ends” command at the end of the macro. It seems the macro prevents this infinite loop (it does “Fade Ends” twice), but perhaps insertion of the step should be disallowed.
 
Bill: It is possible to insert a step that is the macro you are editing. For example, edit the supplied “Fade Ends” macro by inserting the “Fade Ends” command at the end of the macro. It seems the macro prevents this infinite loop (it does “Fade Ends” twice), but perhaps insertion of the step should be disallowed.
  
 +
* [[User:James|James]] ([[User talk:James|talk]]) Yes, it is intended that a macro can call itself.  If we barred it, we would also have to bar MacroA calls MacroB calls MacroA.  Also MacroA calls NyquistB calls MacroA.  It is both easyand clear to have a recursion limit instead.
  
==Mac bug: typing a command name does not cause the command-list scroller to display the command==
 
Bill: In the “Select Command” dialog (which is invoked by the “Insert” button in the Manage Macros dialog), it is possible to type some characters and have a command show up in the “Command” text display box. It would be nice if the scroller would update to show that command in the list.
 
 
For example, if I’m looking for the “Mix and Render” command, I could type “m”, and the scroller would update to show the “MP3 Conversion” command, highlighted, in the (middle of?) the dialog. I could then see the “Mix and Render” command and click on it, or see to arrow down to it, or repeatedly type “m” to move to the next command starting with “m” (same as arrow down, except “m” goes back to “MP3 Conversion” after reaching “Move to Previous Label”).
 
 
Currently, typing “m” followed by down-arrow (or up-arrow) updates the scroller, but typing “m” twice does not.
 
  
 
==Buttons to apply to project and files==
 
==Buttons to apply to project and files==
 
David: The labels on the buttons are Project and Files... . Screen readers only read the button label, and so don't read the "Apply Macro to" text. Without changing some wxWidgets code, the accessibility name of a button can't be changed to be different from its label. I suggest that the button labels are changed to "Apply to project", and "Apply to Files...", and the static text is removed. I also think this is more readable for sighted users.
 
David: The labels on the buttons are Project and Files... . Screen readers only read the button label, and so don't read the "Apply Macro to" text. Without changing some wxWidgets code, the accessibility name of a button can't be changed to be different from its label. I suggest that the button labels are changed to "Apply to project", and "Apply to Files...", and the static text is removed. I also think this is more readable for sighted users.
 +
 +
* [[User:James|James]] ([[User talk:James|talk]]) Is this [http://bugzilla.audacityteam.org/show_bug.cgi?id=577 Bug 577] biting us again?  If the static text can't be read, I would advocate patching wxWidgets to improve the button accessibility and try to get that pushed upstream.  I'm not keen on long button text.

Revision as of 16:23, 22 March 2018

This page is intended for gathering together issues and discussions regarding the transition to Macros from Chains for 2.3.0

James' Notes

  • ToDo.png Create / Add some more built in Macros in time for the May 12th Preview version.
  • ToDo.png Implement Import and Export (can be after the Preview)
  • ToDo.png (Paul?) Drag-and-drop too, for Import.
  • ToDo.png Edit button to work for commands with no parameters, so we can see their script id and type.
  • ToDo.png (Aspirational) Find-command entry box in Select Command dialog.
  • Done.png Custom names for All None etc.
  • ToDo.png Persistent settings for export-as

Enhancement Requests

  • ToDo.png More flexibility on export formats.
    • Export as M4A(AAC) and AIFF
  • ToDo.png More flexibility on export file names
    • Prompt for output directory
    • Prefix and suffix control for file names.
  • ToDo.png Avoid file overwrite on apply-to-project or apply-to-files.
    • OPTION: Prompt with OK/NO
    • OPTION: Automatically include a number.
  • ToDo.png Warn if no export step in an export-files chain.
  • ToDo.png Message to gain a pause option, so can be used as breakpoint.
    • The 'real' work here is making messages appear during processing, not at the end, as they are buffered up for display.


Bugs

Bug (untracked) - Mac crash on second invocation of Tools > Macro

A second related instance is reported on the Forum Bug: Audacity 2.3.0 crashes on second entry to Manage Macros

Bug (untracked) - Nested "cleaned" folders

Not only do we get the regression of interrupting the automated process with requests for user input - we also get the bug of the nested "cleaned" folders. This bug is not yet logged on Bugzilla pending discussions on desired behaviors.

Bug 1854 - Un-warned export file overwrite danger in 2.2.2 Chains

Apply Chain can silently overwrite an existing file of the same name in the "cleaned" folder - and this is done with no warning to the user (as one would normally expect with potential file over-writes.

The current behavior of 2.3.0 alpha Macros side-steps this issue with its user interrupts for file locations - and goes on to issue an overwrite warning if the user does not change the filename - but the overwrite is allowable of course. The current 2.3.0 is probably a regression (discussed elsewhere) - hence this bug stands.

Bug (untracked) - Mac: typing a command name does not cause the command-list scroller to display the command

Bill: In the “Select Command” dialog (which is invoked by the “Insert” button in the Manage Macros dialog), it is possible to type some characters and have a command show up in the “Command” text display box. It would be nice if the scroller would update to show that command in the list.

For example, if I’m looking for the “Mix and Render” command, I could type “m”, and the scroller would update to show the “MP3 Conversion” command, highlighted, in the (middle of?) the dialog. I could then see the “Mix and Render” command and click on it, or see to arrow down to it, or repeatedly type “m” to move to the next command starting with “m” (same as arrow down, except “m” goes back to “MP3 Conversion” after reaching “Move to Previous Label”).

Currently, typing “m” followed by down-arrow (or up-arrow) updates the scroller, but typing “m” twice does not.

  • James (talk) Mac only, it seems. Will have a look when I am on that platform.



Bug list

IDPStatusSummary (10 tasks) ID
1854P1RESOLVEDUn-warned export file overwrite danger in 2.2.2 Chains and 2.3.0 Macros1854
878P3RESOLVEDBuilt in Generators don't work correctly in Chains878
876P3RESOLVEDWindows: Macros: LV2 plug-in effects only save default parameters.876
1237P4RESOLVEDMacros: Inconsistent per-platform behaviour cancelling in-progress Macro applied to project.1237
1742P4RESOLVEDBuilt-in Macro name "MP3 Conversion" does not translate1742
1793P4RESOLVEDAutomatic zoom to fit of imported audio does not work in Chains1793
526P4RESOLVEDWindows: Chains: Select Command sets width of all columns by width of longest command526
1238P4RESOLVEDChains: Non-interactive "Apply Chain" window obscured.1238
1745P4RESOLVEDNames of commands in Chains do not translate, and the English uses ugly CamelCase1745
1807P4RESOLVEDNyquist Prompt Scripting command is not functional1807


Regression testing Macros versus Chains

As outlined in recent email on Quality - germane points to be summarized here.

Macros and Chains behave differently on Export

We need to decide what is desired-behavior on Export from Macros.


Wording - "Cleaned" versus "cleaned" folder name

Peter (and Connie) would prefer the "cleaned" folder to be capitalized - or Peter would prefer it be renamed to "Macro Output" Bill would prefer the user to be prompted for the export folder. See above Parameter setting for "Export as ..." in Macros


Renaming macros

Bill: Given that a macro can be called from another macro, is it not dangerous to allow macros to be renamed?


Should a macro be able to call itself, and what does it mean if it does?

Bill: It is possible to insert a step that is the macro you are editing. For example, edit the supplied “Fade Ends” macro by inserting the “Fade Ends” command at the end of the macro. It seems the macro prevents this infinite loop (it does “Fade Ends” twice), but perhaps insertion of the step should be disallowed.

  • James (talk) Yes, it is intended that a macro can call itself. If we barred it, we would also have to bar MacroA calls MacroB calls MacroA. Also MacroA calls NyquistB calls MacroA. It is both easyand clear to have a recursion limit instead.


Buttons to apply to project and files

David: The labels on the buttons are Project and Files... . Screen readers only read the button label, and so don't read the "Apply Macro to" text. Without changing some wxWidgets code, the accessibility name of a button can't be changed to be different from its label. I suggest that the button labels are changed to "Apply to project", and "Apply to Files...", and the static text is removed. I also think this is more readable for sighted users.

  • James (talk) Is this Bug 577 biting us again? If the static text can't be read, I would advocate patching wxWidgets to improve the button accessibility and try to get that pushed upstream. I'm not keen on long button text.