mirror of
https://github.com/cookiengineer/audacity
synced 2025-07-31 07:59:27 +02:00
81385d7ebd
A very extensive rewrite.
No longer:
1 Test a type field of a track and then do a C-style pointer down-cast
2 Use verbose old iterators over tracks that required those down-casts
3 Detect that a track has a stereo partner by testing Track::GetLink();
Detect that a track is the left stereo channel by testing Track::GetLinked()
4 Do something to one channel of a pair, then repeat on the other channel
5 Set up new or imported stereo tracks with Track::SetLinked() and setting of
channel types
Instead:
1 -- Use track_cast, which won't cast const away, to convert a pointer, getting
null if the track is not of the specified type
-- Or use Track::TypeSwitch which takes lambda expressions with arguments of
desired subtypes, entering the lambda body only if the track has the
right type
-- Or use TrackIterRange<...>::Visit() or VisitWhile() to apply a
type-switch over each of several tracks.
2 -- Use TrackList::Any() or Selected() or other new functions, which return
TrackIterRange<...> objects that represent ranges of tracks to be visited.
-- Use the template type parameter to restrict visitation to a subtype and
cause the pointer down-cast to be built in to the iterator deferences.
-- Use C++11 range-for or stl algorithms with TrackIterRanges for brevity
-- Or even avoid loops by using size() or min() or similar member functions
of TrackIterRange.
-- Use StartingWith(), EndingAfter(), Excluding(), and operators + and -
(which can take arbitrary predicates on tracks) to filter the range object
and simplify loop bodies even further.
3 -- Use Track::IsLeader() to test whether a track is first in a channel group
(which also returns true when it is not grouped with any other track, and
maybe not even a WaveTrack)
-- Or use TrackList::FindLeader() to get the first member of its group
-- Or use TrackList::Leaders() to get a track range that includes leaders
only, then visit that range as in (2).
4 -- Use TrackList::Channels() to get a TrackIterRange that includes only
the members of the group of a given track and visit that as in (2).
-- Do not needlessly assume or assert that the channels are at most two.
5 -- After all the channels have been added at the end of the TrackList, just
call TrackList::GroupChannels() passing the leader track and number of
channels.
Most rewrites covered by (3) and (4) generalize without any complications to
possible future more-than-stereo track groupings. In other places, there may
be some difficulty about such generalization, and those are marked with the
comments:
// TODO: more-than-two-channels
or else
// TODO: more-than-two-channels-message
where it was merely a matter of more appropriate wording for the user. This
branch makes no changes to user-visible messages.
What isn't changed in the interface exposed by TrackList and Track:
-- Grouped channels are always a contiguous sub-range of all tracks, and
client code may rely on that assumption.
What isn't changed in the implementaion:
-- Channel groups are never yet actually more than two.
-- The grouping of channels is still represented by a boolean flag in each
track that is true only for the first channel of each stereo pair.
-- The persistent representation of channel groups in .aup files.
Audacity(R): free, open source, cross-platform audio software for
multi-track recording and editing: https://www.audacityteam.org/ .
User support is provided on Audacity Forum:
https://forum.audacityteam.org/ .
We welcome feedback on Audacity, suggestions for new or improved features,
and bug reports. Please visit https://forum.audacityteam.org/viewforum.php?f=25 .
Audacity is copyright (c) 1999-2018 by Audacity Team. This copyright
notice applies to all documents in the Audacity source code archive,
except as otherwise noted (mostly in the lib-src subdirectories).
"Audacity" is a registered trademark of Dominic Mazzoni.
The Audacity documentation is licensed under the Creative Commons
Attribution 3.0 license: https://creativecommons.org/licenses/by/3.0/legalcode .
Compilation instructions for Audacity are provided in the source code:
* Windows: win\build.txt
* macOS: mac/build.txt
* GNU/Linux: linux/build.txt
You can ask for help with compilation problems at:
https://forum.audacityteam.org/viewforum.php?f=19 .
If you want to suggest some simple text change in our code, please submit a
pull request on https://github.com/audacity/audacity/pulls . It's usually
best to discuss functional code changes with us first on audacity-devel:
https://lists.sourceforge.net/lists/listinfo/audacity-devel .
Version 2.3.0
Contents of this README:
1. Licensing
2. Changes since version 2.2.2
3. Known Issues at Release
4. Source Code, Libraries and Additional Copyright Information
--------------------------------------------------------------------------------
1. Licensing
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version. The program source code is also freely
available as per Section 4 of this README.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
License for more details.
You should have received a copy of the GNU General Public License
along with this program (in a file called LICENSE.txt); if not, go
to https://www.gnu.org/licenses/old-licenses/gpl-2.0.html or write to
Free Software Foundation, Inc.
59 Temple Place - Suite 330
Boston, MA 02111-1307 USA
-------------------------------------------------------------------------------
2. Changes since version 2.2.2:
Improvements
* New feature - "Punch and Roll Recording".
* Pinned-play-head can now be repositioned by dragging
* Play-at-Speed now can be adjusted whilst playing.
* Toolbars controlling volume and speed can now be resized for greater precision
* Macros (formerly 'Chains') substantially extended
* New Macro palette
* Macros can be bound to keyboard keys
* New commands
* New 'Tools' menu
* New 'Scriptables' commands
* Nyquist gains AUD-DO command
* Nyquist effects are now translatable and translated
* More dialogs have help buttons now
* Increased legibility of trackname display
* Half-wave option for collapsed tracks
* Sliding Stretch
* Dialog (option) for entering labels
See also: https://wiki.audacityteam.org/wiki/New_features_in_Audacity_2.3.0
Bug Fixes
Over 90 bugs in 2.2.2 fixed, including:
* Windows: Queen Mary 1.7.1 Vamp plug-ins crash Audacity on opening Plug-in Manager - bug #1244
* Inconsistent behavior when recording with a selection defined - bug #1839
* Ctrl + M does not open label for editing - bug #1852
* Vertical Zoom in by clicking in the vertical Scale, or context menu, in waveform views is inconsistent - bug #1810
* Deletion of all tracks cannot be undone - bug #1845
* Timer Record with a selection present can get a truncated recording with data loss - bug #1851
* Duplicate shortcuts can be created - bug #1786
* Labels longer than 260 characters are now supported - bug #1905
* Using Spectrogram Settings in TCP or using Preferences causes Audacity to reset Project Rate to default rate in Quality Preferences - bug #1977
* Cut Preview should play all selected/sync-locked tracks, respecting Mute/Solo during preview - bug #231
See also: https://wiki.audacityteam.org/wiki/Release_Notes_2.3.0
-------------------------------------------------------------------------------
3. Known Issues in 2.3.0:
For known issues in 2.3.0 please see:
https://wiki.audacityteam.org/wiki/Release_Notes_2.3.0/Issues
-------------------------------------------------------------------------------
4. Source Code, Libraries and Additional Copyright Information
Source code to this program is always available; for more information visit
our web site at:
https://www.audacityteam.org/download/source
Audacity is built upon other free libraries; some of these libraries may have
come with Audacity in the lib-src directory. Others you are expected to install
first if you want Audacity to have certain capabilities. Most of these libraries
are not distributed under the terms of the GPL, but rather some other free,
GPL-compatible license. Specifically:
expat: BSD-like license.
Provides XML parsing. Included with Audacity.
FFmpeg: GPL or LGPL (according to how you obtain/configure it)
Provides decoding/encoding of additional formats. Optional separate
download.
libid3tag: GPL
Reads/writes ID3 tags in MP3 files. Optional
separate download as part of libmad.
libflac: Xiph.Org BSD-like licence (the parts we use)
Decodes and Encodes Free Lossless Audio Codec files. Optional separate
download.
libmad: GPL
Decodes MP3 files. Optional separate download.
libnyquist: BSD-like license.
Functional language for manipulating audio; available
within Audacity for effects processing.
libogg: BSD-like license.
Optional separate download, along with libvorbis.
libsndfile: LGPL
Reads and writes uncompressed PCM audio files.
Included with Audacity.
libsoxr: LGPL
The SoX Resampler library performs one-dimensional sample-rate conversion.
libvamp: new-style BSD
Plug-in interface and support library for audio analysis plug-ins.
Included with Audacity.
libvorbis: BSD-like license.
Decodes and encodes Ogg Vorbis files. Optional
separate download.
lv2: a merging of the lilv (ISC license), lv2 (LGPL), msinttypes, serd (ISC),
sord, sratom, and suil libraries to support LV2 plug-ins.
portsmf: BSD-like license.
library for reading and writing midi files. Included with Audacity
sbsms: GPL v2
Pitch and tempo changing library. Included in Audacity
SoundTouch: LGPL
Changes tempo without changing pitch and vice versa.
Included in audacity
Twolame: LGPL
Encodes MPEG I layer 2 audio (used in DVDs and Radio). Optional separate
download.
wxWidgets: wxWindows license (based on LGPL)
Cross-platform GUI library - must be downloaded and
compiled separately.
For more information, see the documentation inside each library's
source code directory.
--------------------------------------------------------------------------------
Additional copyright information:
--------------------------------------------------------------------------------
Nyquist
Copyright (c) 2000-2002, by Roger B. Dannenberg
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
Redistributions of source code must retain the copyright notice, the
list of conditions, and the disclaimer, all three of which appear below under
"COPYRIGHT AND LICENSE INFORMATION FOR XLISP."
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
Redistributions in binary form must reproduce the copyright notice, the
list of conditions, and the disclaimer, all three of which appear below under
"COPYRIGHT AND LICENSE INFORMATION FOR XLISP," in the documentation
and/or other materials provided with the distribution.
Neither the name of Roger B. Dannenberg, Carnegie Mellon University, nor the
names of any contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
COPYRIGHT AND LICENSE INFORMATION FOR XLISP (part of Nyquist):
Copyright (c) 1984-2002, by David Michael Betz
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
Neither the name of David Michael Betz nor the names of any contributors may be
used to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.