annotate CHANGELOG @ 309:12eadc54e874

Start rejigging README
author Chris Cannam
date Tue, 11 Jul 2017 18:00:08 +0100
parents 252380f1b361
children 68305800139d
rev   line source
Chris@294 1
Chris@294 2 Changes in Sonic Annotator 1.5 since the previous release 1.4:
Chris@294 3
Chris@294 4 Front-end changes:
Chris@294 5
Chris@294 6 - Change mp3 file loading so as to compensate for encoder/decoder
Chris@294 7 delay and padding (using "gapless playback" logic). While this is a
Chris@294 8 real improvement, unfortunately it does mean that the initial
Chris@294 9 padding in mp3 file load has changed from previous versions, which
Chris@294 10 may change alignment of features based on mp3 files relative to
Chris@294 11 those generated by previous versions. It's not a great idea to use
Chris@294 12 mp3 as a file format of record, because of differences like this
Chris@294 13 between decoders
Chris@294 14
Chris@294 15 - Add --transform-minversion flag to test for available version of
Chris@294 16 a plugin transform
Chris@294 17
Chris@294 18 - Add quiet mode (-q)
Chris@294 19
Chris@294 20 Bug fixes:
Chris@294 21
Chris@294 22 - Fix possible crash in multiplexed file handling (--multiplex, -m)
Chris@294 23
Chris@294 24 - Fix nominal rounding error (out by 1ns) in output under some
Chris@294 25 conditions
Chris@294 26
Chris@246 27
Chris@246 28 Changes in Sonic Annotator 1.4 since the previous release 1.3:
Chris@246 29
Chris@246 30 Front-end changes:
Chris@246 31
Chris@246 32 - Better error reporting, especially for invalid transform files
Chris@246 33 and transform-not-found
Chris@246 34
Chris@246 35 - Avoid crashing out when a single plugin (that is not being used)
Chris@246 36 can't be loaded because of e.g. an undefined symbol
Chris@246 37
Chris@246 38 Bug fixes:
Chris@246 39
Chris@246 40 - Fix (with test) horrible crash with --multiplex option
Chris@246 41
Chris@246 42 - Fix erroneous quantization to 16 bits for coded file types of
Chris@246 43 greater bit depth
Chris@246 44
Chris@246 45 - Fix multiple outputs when requesting both summary and non-summary
Chris@246 46 for the same output
Chris@246 47
Chris@246 48
Chris@211 49 Changes in Sonic Annotator 1.3 since the previous release 1.2:
Chris@211 50
Chris@211 51 Back-end (feature writer) changes:
Chris@211 52
Chris@211 53 - Add the --csv-digits, --lab-digits, and --jams-digits options to
Chris@211 54 control the number of significant figures printed for feature values
Chris@211 55
Chris@211 56 - Update the JAMS writer to JAMS 0.2.0 format
Chris@211 57
Chris@211 58 - Show a more useful error message when user provides a filename
Chris@211 59 instead of a transform id to the -d option (happened to me when
Chris@211 60 cut-and-pasting command lines and I was quite baffled at first)
Chris@211 61
Chris@200 62
Chris@200 63 Changes in Sonic Annotator 1.2 since the previous release 1.1:
Chris@200 64
Chris@200 65 Front-end changes:
Chris@200 66
Chris@200 67 - Add the --segments-from option, providing the ability to read
Chris@200 68 segment boundaries from a file
Chris@200 69
Chris@200 70 Back-end (feature writer) changes:
Chris@200 71
Chris@200 72 - Rename the JSON feature writer to JAMS. There may be other JSON
Chris@200 73 formats supported in future
Chris@200 74
Chris@200 75 Bug fixes:
Chris@200 76
Chris@200 77 - Fix invalid JSON written by JAMS feature writer for dense
Chris@200 78 features.
Chris@200 79 - Fix invalid UTF-8 output from RDF feature writer when processing
Chris@200 80 MP3 files having ID3 tags in non-ASCII, non-UTF8 encodings
Chris@200 81
Chris@127 82
Chris@127 83 Changes in Sonic Annotator 1.1 since the previous release 1.0:
Chris@127 84
Chris@127 85 Front-end changes:
Chris@127 86
Chris@127 87 - Add support for the start time and duration properties of a
Chris@127 88 transform, applying a plugin to only a range of the input audio
Chris@179 89 - Reduce the internal processing blocksize from 16384 to 1024 samples
Chris@179 90 to reduce extent of time rounding at end of file or range
Chris@128 91 - Add --multiplex option to compose multiple audio files into a
Chris@128 92 single multi-channel stream with one input file per channel
Chris@172 93 - Add --normalise to request each audio file be normalised to 1.0 max
Chris@172 94 - Add support for the plugin_version property of a transform, causing
Chris@172 95 Sonic Annotator to refuse to run with the wrong version of a plugin
Chris@128 96 - Add --minversion option to permit scripts to check that the
Chris@128 97 version of Sonic Annotator is as they expect
Chris@172 98 - Add new housekeeping options to list the available feature writers
Chris@172 99 and supported audio file formats
Chris@172 100 - Pull out the feature-writer-specific help text into separate help
Chris@172 101 options (-h <writertype>) as the help was getting too long
Chris@172 102
Chris@172 103 Back-end (feature writer) changes:
Chris@172 104
Chris@172 105 - Add --csv-omit-filename, --csv-end-times, and --csv-fill-ends
Chris@172 106 options to the CSV feature writer to adjust various aspects of its
Chris@172 107 output
Chris@172 108 - Add "json" feature writer, exporting to JAMS (JSON Annotated Music
Chris@181 109 Specification) format. This writer is provisional and is expected
Chris@172 110 to change in future releases to comply more effectively with the
Chris@172 111 specification
Chris@172 112 - Add "midi" feature writer, exporting to MIDI files
Chris@172 113 - Add "lab" feature writer, exporting to tab-separated label files.
Chris@172 114 (This is equivalent to using the CSV writer with a tab separator and
Chris@172 115 the new --csv-omit-filename and --csv-end-times options, but it's
Chris@172 116 simpler to use if .lab is what you want)
Chris@128 117
Chris@128 118 Bug fixes:
Chris@128 119
Chris@128 120 - Fix the former habit of forging ahead even if not all transform
Chris@128 121 files could be found or parsed (this may have been intentional
Chris@128 122 behaviour but it is confusing more than it is useful)
Chris@128 123 - Fix failure to support --summary-only flag when reading transforms
Chris@128 124 with summaries from a transform file
Chris@71 125
Chris@172 126
Chris@86 127 Changes in Sonic Annotator 1.0 since the previous release 0.7:
Chris@71 128
Chris@87 129 Bug fixes:
Chris@87 130
Chris@71 131 - Fix incorrect samplerate in reading m4a files on OS/X
Chris@73 132 - Fix incorrect handling of FixedSampleRate outputs (Vamp SDK fix)
Chris@86 133 - Add tests that use the Vamp test plugin
Chris@65 134
Chris@172 135
Chris@65 136 Changes in Sonic Annotator 0.7 since the previous release 0.6:
Chris@65 137
Chris@65 138 Build changes:
Chris@65 139
Chris@65 140 - Support 64-bit builds on OS/X (using CoreAudio instead of
Chris@65 141 obsolete QuickTime audio file reader)
Chris@65 142
Chris@65 143 - Simplify RDF reading and fix some bugs. Now requires Dataquay
Chris@65 144 (http://breakfastquay.com/dataquay/) rather than using Redland
Chris@65 145 directly. Release builds use Sord/Serd rather than Redland
Chris@49 146
Chris@172 147
Chris@49 148 Changes in Sonic Annotator 0.6 since the previous release 0.5:
Chris@49 149
Chris@49 150 Build changes:
Chris@49 151
Chris@49 152 - Switch to modular SV-libraries build using svcore library
Chris@53 153 - We now require Vamp plugin SDK v2.3
Chris@49 154 - Add autoconf configure script
Chris@49 155
Chris@49 156 Front-end changes:
Chris@49 157
Chris@49 158 - Pick up default sample rate and channel count from the first
Chris@49 159 audio file, where not specified in the transform, instead of using
Chris@49 160 hard coded defaults
Chris@53 161 - Make it possible to specify the window shape in transform
Chris@49 162 - Fix the --csv-one-file option which did not work in 0.5
Chris@49 163 - Fix --force option when using playlists
Chris@49 164 - Add -v option to print version number and exit
Chris@36 165
Chris@172 166
Chris@36 167 Changes in Sonic Annotator 0.5 since the previous release 0.4:
Chris@36 168
Chris@36 169 Build changes:
Chris@36 170
Chris@36 171 - Remove unused audioio library and avoid its dependencies
Chris@36 172
Chris@36 173 Front-end changes:
Chris@36 174
Chris@36 175 - Avoid leaking file descriptors on exceptions
Chris@36 176 - Fix embarrassing bug that caused failure to mix down to mono
Chris@36 177 properly for single-channel plugins with multi-channel input files
Chris@36 178 - Fail sooner if the output file is not writable (i.e. don't wait
Chris@36 179 until the first data is available for writing)
Chris@23 180
Chris@172 181
Chris@27 182 Changes in Sonic Annotator 0.4 since the previous release 0.3:
Chris@27 183
Chris@27 184 Build changes:
Chris@27 185
Chris@27 186 - Sonic Annotator now requires the Vamp plugin SDK v2.1 or newer.
Chris@27 187
Chris@27 188 Front-end changes:
Chris@27 189
Chris@28 190 - Frequency-domain plugins now use the PluginInputDomainAdapter's new
Chris@28 191 ShiftData processing method, ensuring that the first block received
Chris@28 192 by the plugin is the one centred on 0 rather than starting at 0.
Chris@28 193 Unfortunately, the old behaviour omitted a timing compensation step,
Chris@28 194 and this fix actually changes the results from some plugin processes:
Chris@28 195 the previous behaviour was not always in line with the Vamp plugin
Chris@28 196 specification.
Chris@28 197
Chris@27 198 - More useful diagnostics are now available when a plugin fails to
Chris@28 199 load or run.
Chris@27 200
Chris@27 201 CSV back-end (feature writer) changes:
Chris@27 202
Chris@27 203 - The CSV writer now closes its output files properly when it
Chris@27 204 finishes writing to each one, rather than leaving them all open
Chris@27 205 until the end and risk running out of file descriptors. This was
Chris@27 206 already the behaviour of the RDF writer, the CSV one has just been
Chris@27 207 updated to match it.
Chris@27 208 - The behaviour of the CSV writer has also been changed to match
Chris@27 209 that of the RDF writer in handling file write failures (it now
Chris@27 210 continues processing only if --force is given).
Chris@27 211
Chris@27 212
Chris@27 213 Changes in Sonic Annotator 0.3 since the previous release 0.2:
Chris@23 214
Chris@23 215 Front-end changes:
Chris@23 216
Chris@23 217 - A new --force front-end option (distinct from the --csv-force and
Chris@23 218 --rdf-force back-end options) has been added, which makes Sonic
Chris@23 219 Annotator continue to process subsequent audio files instead of
Chris@23 220 exiting after an error, if multiple audio files have been specified.
Chris@23 221
Chris@23 222 RDF back-end (feature writer) changes:
Chris@23 223
Chris@23 224 - The RDF writer now conforms more correctly with the Music Ontology
Chris@23 225 in the way it relates signal, track, and track metadata. Signals
Chris@23 226 that have available metadata now gain a Track resource to associate
Chris@23 227 that metadata with, instead of hanging it directly from the Signal
Chris@23 228 resource; also the audio file now encodes the signal rather than the
Chris@23 229 signal being available as the audio file (matching the domain
Chris@23 230 specification of the Music Ontology). Note that this new resource
Chris@23 231 structure will not be properly read by versions of Sonic Visualiser
Chris@23 232 prior to 1.6 (should importing the data into Sonic Visualiser be of
Chris@23 233 interest to you).
Chris@23 234
Chris@23 235 - The --rdf-signal-uri option has been removed and replaced with the
Chris@23 236 more meaningful set of options --rdf-audiofile-uri, --rdf-track-uri,
Chris@23 237 and --rdf-maker-uri.
Chris@23 238
Chris@23 239 - A new --rdf-network option is available, to cause Sonic Annotator
Chris@23 240 to try to retrieve RDF descriptions for plugins from the network
Chris@23 241 where those descriptions are not available locally. Use of this
Chris@23 242 option is recommended, but it is not the default because of the
Chris@23 243 possible performance implication (even though the results are mostly
Chris@23 244 cached, there may be some network access involved).
Chris@23 245
Chris@23 246 - The RDF writer now writes the computed_by property for signal
Chris@23 247 features.
Chris@23 248
Chris@23 249 - Plugin and output URIs in the resulting RDF are now percent-encoded.
Chris@23 250