Release Checklist

From Audacity Wiki
Revision as of 10:39, 25 August 2007 by James (talk | contribs) (Updates to priority aim-tos)
Jump to: navigation, search

This list should only be modified by subscribers to Audacity-devel mailing list.

  • To understand what this Checklist is for and how it is used, please join that list or read the list archives on sourceforge.
  • Following a suggestion by Jeroen, this list has been put on the wiki and the 'Done' items separated from the items that are still to do.

These all for 1.4.0 release. It's likely we'll have a 1.3.4 beta as a 1.4.0 candidate.

To take ownership of an issue, add your initials before it like so:

  • [DM] for Dominic Mazzoni
  • [LL] for Leland Lucius
  • [JC] for James Crook
  • etc...

This is a companion list to the Documentation Checklist

Essential fixes

Fixes are the top category, since it is difficult to estimate how long bugs will take to fix.

  • [JC] Julian's issue of crash when importing same file in second window while first import still proceeding: suggested we have to emulate modal-mode, possibly with our own 'busy' flag.This is a particular case of a more general problem of not being locked-out from initiating new actions when in a progress dialog.

Essential changes

These are other changes to source code that are deemed 'essential'. We will do all of these for a 1.4.0-pre beta.

  • none

Essential fixes: Platform Specific

I put these in a separate category as we could be 'Windows 1.4 ready' but not 'Mac/Linux 1.4 ready', if these are not cleared.

  • [LL] Fix: Unavailable items in application menu on the Mac. How to reproduce
  • [LL] Fix: Random bits of silence during recording (non-Jack version of this problem). [Mac only?] Progress: Udo tried smaller blocksize in linux/jack version of this problem and can now fault after 4 mins. Perhaps small blocksize will help us track down the problem on non-Jack set ups too. However, perhaps Udo's progress is only relevant to using Jack and no help to Mac?
  • Fix: Linux, Recovery action if project rate not supported by card. OK on Windows.
  • Fix: Mac CoreAudio crash when input device's sample rate is 44100 and the output device's sample rate is 48000.
  • Fix: Mac OS X crash on opening 1.2 project files. Is this still an issue?
  • Fix: Mac OS X crash on recovering files. Is this only a Mac issue, and if so do we have any idea why it is Mac specific?
  • Shift-P doesn't open the Panning dialog on the Mac because Pause catches the same key, so we should change that to another key.
  • Address Mihail's issue: PA19 uses oss; without load/compile oss support in alsa (snd-pcm-oss), audacity crashes on init PA19.

Essentials: No longer Issues?

  • Reduce 'greying out' of effects confusion by select-all-when none for effects. We now don't grey out and instead give a dialog with an explanation. This works both for trying to apply an effect whilst playing and with no audio at all present. Warning messages can be customised to match the reason that the action is disallowed.
  • Change dialog when you open a 1.2 project. It shouldn't discourage users from doing it, it should just tell them that this will change the project to a 1.4 project file that can't be opened by 1.2. Current text under discussion on audacity-devel
  • Envelope Handling Fixes: Are these worse than they were in 1.2.5? If not, can we demote them from "essentials" to "aim-to's" so as not to hold up the release? The old issue of envelope points not restoring properly when reopening never quite seems to go away on Macs -see here. Move this to watching brief/Mac issue?
    • Fix: Envelope editing, in particular when you split a track that contains envelope edits - no end points on a 'split' leading to envelope changes on a 'split'.
    • Fix bugs where two tracks in a stereo pair can show different envelopes; they should always be the same. Also fix any sync issues of envelope editing with a stereo pair - the current implementation is prone to error if the tracks are not the same size and don't have synced envelopes to begin with.
    • Fix: Envelope handling when you cut, paste, and join clips. Try to merge envelopes together when you merge two clips together.
    • Fix: Envelope end points not added consistently
    • Fix: Superfluous envelope points added automatically

Watching Brief

These once were issues. They seem to have gone, but some problems seem to come and go, so we keep them here to remind ourselves of them....

  • Intermittent failure to detect playback and recording clipping noted on Windows XP SP2 machine, currently no longer reproducible (GA to report if recurs)
  • Intermittent failure to snap shifted tracks or dragged selections on Windows XP SP2 machine (this is a consistent problem, it works only about every other time Audacity is launched)
  • Keep an eye out for possible lack of closing '</project>' tag in autosaving.
  • Keep eye out for abnormal silence added when exporting selection as MP3 - see Bug 271. Possibly related problem found in 1.3.3 released build with silenced audio in MP3s when exporting multiple with labels. See steps to reproduce. Repeating this test when exporting multiple with tracks instead of labels gives a normal export, as does Export Selection as. None of the above problems yet replicated in CVS. Should be added to Beta 1.3.4 test notes to look out for if not resolved.

Totally unsure...

Probably need discussion on the list before we can release 1.4.

  • Remove VST support
  • Is the screenshot menu item to be available in 1.4.0? Present in debug builds, absent in release?
  • Fix: Jorge's Mis-selection of sample rate as 'default' when card can't support file's rate. Is this now just a matter of documenting the behaviour? Also is the behaviour under Windows and Linux the same now? Also what many users would appreciate (post 1.4.0 if needs be) is a Preference to always have the Project Rate remain as per its Preference setting irrespective of the file being imported. If you want to import say a lot of low sample rate MP3s one by one for export to WAV for CD burning, resetting of the Project Rate where this occurs is a major inconvenience.(GA)

Priority Aim to

These are items which were in the aim-to list which are being prioritised. None of them are show stoppers which can hold up the release.

  • Change Jimmy Johnson's "Help" button to use html text built into the program (about 3 paragraphs).
  • Monitoring ON by default. Feedback from is that ON is OK on low powered machines, and that it being OFF by default leads new users to think their mic is not working.
  • Apply Chris Cannam's vamp patch and SDK 1.1. One reason this is a priority aim-to is that doing it now helps ensure that vamp evolves with Audacity rather than without. Update: Now works with Windows; Soon to be checked in.
  • Ability to add a label by just typing without first typing a ctrl-B, when the selection region is on a single track and the track is a label track.
  • Fix: Old projects open incorrectly - reported by Monty. Status as an 'essential fix' was conditional on developers having a test example they can see the problem on. We don't have examples, so this got demoted.
  • Optional beep on completion of long activities.
  • Fix if a label is duplicated along with its audio, the label is time shifted to zero
  • Truncate silence – disallow max silence duration of "0" as this corrupts the audio (or fix the problem)

Aim to

  • Fix: (low priority) Snapping on playback region - when you enable snapping the playback region jumps to the selection, rather than snapping to the nearest points.
  • Fix: (low priority) Playback region lost. The particular scenario is setting a playback region in the ruler different to the selection, then clicking play. On completion of playback, the playback region reverts to the selection.
  • Ensure Metadata editor appears of its own accord. It does not currently appear either for first or subsequent MP3 exports of its own accord, and should do so also for FLAC and OGG exports. We still need to discuss what is the most appropriate behaviour e.g. always popup on second export in session? This is not a crashing bug, and not having tags isn't a dire problem, so this is now only an aim-to.
  • Either warn when Prefs closed with autosave turned off, or ensure that Audacity warns when restarting after crash with autosave disabled: (1) that temp files are present (2) does not let you exit without reminding of you of those files. Users experienced enough to turn off autosave aren't total newbies. Should expect that turning off autosave reduces likelihood of recovery from errors. Fix not essential. JC This does miss the point that you can accidentally turn off autosave especially if using the keyboard - IMHO though not quite essential it is very important given Audacity gives you no help at all when you restart after a crash with autosave off.(GA)
  • Fix: Selection does not move with time shifting clip. Documentation issue - need to click within selection before dragging.
  • Fix: Selecting inhibits movement of clip onto another track. Only if you click within the selection. Clicking outside allows you to move the clip.
  • Discuss test harnesses. Possibly write some more test code.
  • Springclean docs in root directory, e.g. buglist.txt - delete.
  • Ruler to use same units as selected in selection bar.
  • Use orange for high-water-bar in sound level meter, not blue. Is it not better to use orange for the RMS and red for the peak on both record and playback meters? The confusion is the red for RMS in Recording meter when red is colour for clipping in both meters (GA)
  • Fix all effects so that ALT + the appropriate letter always applies the relevant button without having to change the effect settings first (compressor is one offender). If possible permit all effects including Nyquist to accept the appropriate letter without modifier to apply the button, even if focus is in a text box (this should possibly be "not aiming for 1.4")
  • Determine why ALT+ menubar access key doesn't work when label track has the focus.
  • Hide all warnings except the first when exporting multiple MP3s with illegal sample rate/bit rate combination.
  • Fix: Jorge's pop-click on starting Audacity.
  • Once suitable modification in place, consider a Nyquist plug-in for creating a cue sheet or possibly direct Export as Cue Sheet, as discussed with Leland (but can be moved to "not aiming" if needs be)
  • When selecting a region over a label and cutting or copying, ensure label text, not the system clipboard content, is pasted into the text of the label
  • When selecting a region over a label that denotes a selection area and cutting or copying, ensure the pasted label is of the selection region, not a cursor point (this is a regression on 1.2.6)
  • Prevent Edit > Silence removing a label, it should only silence the referenced audio
  • Ensure proper saving of exported audio file when Audacity runs out of space and warn what was done, especially on Linux (seems on Windows that a clean file is saved). Consider checking free space before starting export
  • Fix deleting entire area of a Label track between two labels deletes the right-hand label
  • Check labels consistently allow entry of z (reported by Julian on Linux)
  • Check typing square brackets in labels bring up a "move the audio cursor to start/end" dialogue rather than inserting as text (reported by Julian on Linux but not apparent to GA on Windows)
  • Grey out Edit > Split New when no audio selected
  • Track display: when a labelled region is selected, the display has a one-pixel gap between RHS of grey selection and the RHS line of the label selected. [JC]
  • Label text editing: Selecting part of label text by dragging with the mouse doesn't start selection at beginning of drag, but at wherever the text cursor was previously
  • Left single-clicking no longer removes cut lines and clip boundaries, but left double-clicking does. Ensure that click or double-click close to the line snaps to it.
  • Prevent Effect > Repeat drawing clip boundaries at each repeat and ensure no undo history written for each repeat.
  • Change cut line colour from red as this is now the colour for View Clipping [MS]
  • A new icon for <->, since it now moves things up and down as well [MS]

Aim to release at same time

  • The new Nyquist plug ins.

Not aiming to do for 1.4.0

  • Fix: Random bits of silence during recording (Jack version of this problem). Progress: Udo has tried smaller blocksize. Can now fault after 4 mins, rather than an hour. Richard has done some experiments and found that Audacity-With-Jack is seriously broken. We can't release Audacity-with-Jack for 1.4.
  • [JC] A little more useful diagnostics in the benchmarking dialog, and possibly some instrumentation of the blockfile system.
  • Fix halving of bitrate for mono MP3 tracks - bugzilla:182. Is a feature request. Depends whether we consider bytes/sec of audio or bytes/sec/track the more important, and that may vary from one user to another. Bugzilla has been updated to reflect this.
  • Theme: Fix: Updating theme causes PortAudio selector drop down in mixer toolbar to disappear.
  • Batch: More example chains.
  • Batch: Better naming of preference parameters.
  • [LL] All keyboard shortcuts changable.
  • Radio button for initial language choice.
  • Split at labels to do so with end-to-end labels too.
  • [LL] All Fx dialogs using ShuttleGui.
  • [LL] Greater consistency of '...' in History list.
  • Play/rec sync in portaudio v19 for Windows
  • Max zoom - Ruler/track highlighting out of sync.
  • Max zoom - samples starting before left edge of track aren't plotted while samples extending past right edge are.
  • Max zoom - possible error while plotting negative values.
  • [LL] Mouse cursor doesn't change when it should if keyboard is used.
  • Discuss adding Preferences setting for fonts except the Label Track.
  • Add FFTW library
  • Branches into Plug-Ins?
    • [VJ] Port Lyrics Windows from UmixIt custom build.
    • [VJ] Port Branding from UmixIt & Thinklabs custom builds.
    • [VJ] Port other miscellaneous features from UmixIt & Thinklabs custom builds.
  • Idea: display envelope handles linearly, but just implement them exponentially under the hood. That would make the GUI potentially much easier. should never have been in the essentials list.
  • DirectSound Gui support.
  • Two sample alternative themes. [Themeability prefs will be disabled in stable 1.4 release and release candidate, only available in unstable builds.]
  • Labels to move with WaveTrack edits rather than be at fixed times.
  • Dominic's pipe-based scripting. [Could lift this into the aim-to list. It depends on status of the code developed so far. We could perhaps use it in test harness, if it is already nearly there.]
  • Modeless Fx dialogs. Realtime Fx. [Could not produce stable for 1.4.0 version in the timescale.]
  • Vary selection boundaries during loop play, and have sound respond. [This is a small step in real time Fx]
  • Rework Fx dialogs to use spin boxes.
  • Merging of change-pitch-speed Fx.
  • Look at possibility of supporting right-to-left languages in labels
  • Provide help-link on prefs panel.
  • 'Hidden features' via registry/ini file. Just disable outright for 1.4.0.
    • Hide/disable CleanSpeech (contact Lynn?) leave as is for 1.4.0??
    •  ??Hide/disable FTP (contact Wing Yu?)
    • Hide/disable Theme Prefs 'already disabled for 1.4.0'
    •  ??Hide/disable 'Advanced Mixing' [to be discussed....]??
  • [MJS or anybody else] Finish PauseRecOnSilence - pre/post roll would be good.
  • Add crossfade when looping to prevent possible clicks/pops.
  • Fix cursor problem when clicking on resizer between tracks. Please describe the problem in more detail Add two mono tracks, click within second track to position cursor, click and drag inbetween tracks to resize, release mouse button. First track gains focus causing both tracks to have a cursor drawn.
  • Batch processing on imported files needs to clear temp files after each export to allow unattended processing of many files
  • Snap/Snap-to:
    • Fix labels added with "Add label at Playback position" aren't recognised by Snap
    • Fix Cut lines not recognised by Snap
    • Snap-to option that does nearest vertical crossing left-to-right-rising), enabled by default.
  • [LL] Extend usability of TimeTextCtrl for screen readers
  • Fix: Label lines disappear when label track height is larger than track panel height...maximize project window, add labels, resize label track to fill window, decrease window height, and scroll...label lines will disappear.
  • Fix: Do not resize track when pointer is at top of track...move cursor outside the top of a track, move down slowly until the pointer changes shape (like the pencil or i-beam), now left click and drag up and down...the bottom of the track will be resized.
  • [JC] Apply James' patch to prevent missing numbers on timeline
  • Export multiple with chains
  • Add shortcut key which would allow you to move all the track faders together by the same amount (consider for 1.5.0)

Essential fixes/changes - Done

  • Change logic for import and open of files, so that we reject .wma and similar unsupported files before seeing if we can open them with a supported importer. Also warn the user in the case where we had to guess which importer to use. [Done]
  • Improved warning message on close on empty. [Done]
  • Move prompt to save on empty from batch preferences to interface preferences. [Done]
  • Fix: Import Raw crashes Audacity when you select encodings from dropdown list [Done]
  • Fix: Lose track selection, but no refresh, when click on track panel background. Was in the 'unsure' category, but now confirmed OK on windows. [Done]
  • Update mouse preferences panel to show new bindings. [Done]
  • #ifdef FTP menu item to be experimental only. (Longer term FTP needs to migrate to a plug-in or better still a bridge). [Done]
  • Fix: Problem (crash) with playback of audio mix containing different bitrates. For scenario to reproduce, contact James or Federico [Done]
  • Provide 'Unrecognised Audio File Format' dialog with help-link button for more detail. Jimmy Johnson's patch now applied [Done]
  • Fix when File > Save Project As.. empty Project and force quit Audacity, recovered Project has no audio. Steps to reproduce here. While fixing, consider disallowing Save Project As/allowing Save Project when saving empty Project to save user confusion whenever saving. Problems were due to extra 'project' tag. and channel number being set to number-of-channels. [Done]
  • Fix no close button 'X' in title-bar of metadata editor, under Windows XP. [Done]
  • Fix selection edge moving when opposite edge dragged past it [Done]
  • Fix ruler font size. [Done]
  • Fix ruler off-by-a-few pixels...vertical and horizontal rulers. [Done]
  • Fix hotkeys not working until you visit the menus. [Done]
  • Fix temp-directory used for Theme on Mac AND linux AND PC. [Done]
  • Fix metadata editor crash in debug builds. [Done]
  • Fix ID3v2 tags so they are readable by all players not just iTunes [Done]
  • Fix bug in looped play. [Done]
  • Fix Add label adds to first track, not selected track. [Done]
  • Fix multi-clip crash. [Done]
  • Fix freq-window crash. [Done]
  • Fix crash on auto-detection of file format. [Done]
  • Fix position playback cursor for transcription toolbar. [Done]
  • Fix history-window regression. [Done]
  • Fix button release and focus strangeness. [Done]
  • Fix button problem when toggling fast. [Done]
  • Fix MP3 export to export at project rate. [Done]
  • Alert for MP3 invalid bitrate/sample rate combinations. [Done]
  • Fix droplists in toolbars not accessible. [Done]
  • Fix missing mnemonics. [Done]
  • Fix extensions in uppercase not recognised. [Done]
  • Fix _()/wxT() combinations leading to only partial i8ln. [Done]
  • Fix some cases of ruler-clicking play [Done].
  • Fix collision of multi-tool clip drag with (new) play-drag. [Done]
  • Fix Flac-import broken on windows by using text mode for files. [Done]
  • Fix Import MP3 to respect default sample format rather than always use float. [Done]
  • Address Mihail's PA19 wo snd-pcm-os issue and ?????? dev name. [Done. Mihail confirmed]
  • Find scenario to reproduce stray dotted vertical line. [Done]
  • Fix dotted vertical line. [Done]
  • Scrollbars on Linux "randomly" disappear when zooming, adding tracks, ... [Done]
  • Fix need Ctrl+Shift_F twice to fit in window. [Done]
  • Fix slider has no effect in BassBoost Fx. [Done]
  • Fix tools not cycling properly using keyboard. [Done]
  • Fix preferences project rate does not affect main project rate. [Done]
  • Fix label track - clicking label in label track and then a label in a different label track...first label doesn't get unhighlighted. [Done]
  • Fix keyboard prefs on Mac...must click list entries twice...not double click. [Done]
  • Fix label track - cutting or copying text within label doesn't get all selected text. [Done]
  • Fix label track - history not updated when modifying label...text or time. [Done]
  • Address Mihail's dither issue. [Done]
  • Fix label track - clicking label in label track does not set previously selected track to unselected...try it with 2 label tracks and 1 wave track. [Done]
  • Fix resizing meters on Mac jumps to over-under meters. [Done]
  • Fix seek during playback consistently causing track to stop playing before end of track or selection is reached (even occurs with short selections) [Done]
  • Fix bugs listed in Audacity/Jaws tutorial [Done]
  • Template Feature in Metadata Editor is broken [Done]
  • Fix Button order in Click-pop Fx. [Done, I think, at least they are all the same now]
  • Fix enable Snap-to, restart Audacity and Snap indication gone, though snap still enabled [Done]
  • Work out build issues in FileDialog (remove dependence on private wx headers)[Done]
  • Selection Bar's TimeTextCtrls shouldn't reset to 0 when you change formats.[Done]
  • Fix wedge Metadata roll-up open or get Dominic to fine tune [Done]
  • Metadata Editor does not recognise tags in FLAC and OGG files even if created by Audacity. {Done - and seems stable - GA]
  • Fix: Warning dlg if double click MP3 whilst importing MP3 on Mac.
  • Fix: Disallow clicking on menus when a progress dialog is running, as per 1.2.x behaviour (liable to cause crashes). Also consider if commands should be runnable in other Audacity windows while a progress dialogue is already running in one window. Currently this is also possible. This has an interaction with JAWS. It's due to a change in the way progress dialogs are managed. We're currently discussing whether there is an easier way of getting 'ShowModal()' like behaviour without closing-down each prohibited event type individually.
  • Fix: Progress dialog to appear for long Generate effects.
  • Fix: Linux seg fault in dev build caused when dragging a track vertically. Problem tracked down and made reproducable by Julian. 2xStereo track, 1xLabel track, drag up and down about 20 times. Fine on Windows.... Julian reports fixed after code fix 24Aug07.[Done]

Aim to - Done

  • More space in solo/mute buttons for translation. [Done]
  • Chirp effect to have different volume and pitch by default at 30s from at 0s, so that 'chirp' with defaults is not the same as 'tone'. [Done]
  • Clarify reporting of information in benchmark dialog. Blocksize had two meanings in this dialog, we now use the terminology 'blocks' for the files and 'chunks' for the pieces that get cut and pasted during the editing. [Done]
  • TimeTextCtrl colours themable - and new defaults. [Done]
  • Short version of Transcription Toolbar, with just the playback speed control. [Done]
  • Restore split to new track, and smarter re-use of existing tracks with split and duplicate. [Done]
  • Fix Tone-gen combo box not accepting clicks (when using ShuttleGui). [Done]
  • Generate effects to include 'chirp'. [Done].
  • Finish HistoryWindow changes. [Done]
  • Playback position dialogs ('[' and ']') to use TimeTextCtrl. [Done]
  • TimeTextCtrl accepts mouse-wheel. [Done]
  • Cyrilic in Label Track boxes. [Done]
  • Re-enabling tooltips on the Mac. [Done]
  • Add remaining wxColours to the Themability. [Done, to the extent planned for 1.4]
  • Audacity on USB (aka Portable Audacity) - mainly avoid using registry. [Done]
  • Select input source on Mac [Done]
  • wxListCtrl-version of label track. [Done]
  • Make selection bar floating. (using slightly less ambitious variant of trial version) [Done]
  • Batch: *chain* configuration NOT in preferences. [Done]
  • Batch: Solve Markus' issue. [Done]
  • Batch: Stereo and all-export/import-formats supported [Done]
  • Batch: Pre-defined chains in a list rather than via buttons [Done]
  • Fix: Avoid outrageous zoom when vertical sizing. Can someone give more details about what this one is about? You used to be able to zoom in/out to extreme (unreasonable) factors. I believe Martyn corrected this a while back. It no longer occurs.[Done]
  • Font height correction/adjustment in Label Track for Cyrillic chars.[Done]
  • Fix: OK button in label editor should be set as the default[Done]
  • Fix: Pressing ESC while editing a cell in the Label Editor shouldn't terminate the dialog[Done]
  • EQ - fix when start from clean XML, open existing curve, make flat, draw custom curve then save as new name, existing curve is flat when reopened [Done] But check if Julian's related issues are cured

Aim to release at same time - Done

  • Doxygen documentation in place. [Done]
  • Separate zip of LADSPA plug ins.

Not aiming to do for 1.4.0 - Done

  • Taken out some ConsistencyCheck() calls which led to quadratic time algorithms when generating audio. I.e generating long test files took ridiculous amounts of time. These were previously present whether in Debug or Release build.
  • Fix: Edit ID3 Tags did not have a close button in title bar due to Windows Bug.
  • GPL appears in a tab in the AboutBox.
  • Scroller for LADSPA effects dialogs.
  • Reduce area/width of selection bar.
  • Portmixer to support multiple hosts (for DirectSound and ALSA). [Done]
  • DirectSound playback (lower latency) [Done]
  • Added ability to set Track Label font across sessions via the Track Label menu [Done]