# HG changeset patch
# User Chris Cannam
# Date 1441715702 -3600
# Node ID 247a0c471a51c1157a41dc2d05c4d623fe501f4d
# Parent  9f2a6d843639dd50f96c31581412f2a3253cfd6b
Document new messages

diff -r 9f2a6d843639 -r 247a0c471a51 README
--- a/README	Fri Sep 04 13:48:51 2015 +0100
+++ b/README	Tue Sep 08 13:35:02 2015 +0100
@@ -171,16 +171,24 @@
  simple test file.  This may be perfectly reasonable behaviour, but
  you might like to know about it.
 
+ ** ERROR: Plugin output <x> has FixedSampleRate but gives sample rate as 0
+
+ A plugin output that has a sample type of FixedSampleRate must have a
+ non-zero sample rate. See
+ https://code.soundsoftware.ac.uk/projects/vamp-plugin-sdk/wiki/SampleType
+
  ** NOTE: Plugin returns features with timestamps on OneSamplePerStep output
  ** NOTE: Plugin returns features with durations on OneSamplePerStep output
 
  Hosts will usually ignore timestamps and durations attached to any
- feature returned on a OneSamplePerStep output.
+ feature returned on a OneSamplePerStep output. See
+ https://code.soundsoftware.ac.uk/projects/vamp-plugin-sdk/wiki/SampleType
 
  ** ERROR: Plugin returns features with no timestamps on VariableSampleRate output
 
  Timestamps are mandatory on all features associated with a
- VariableSampleRate output.
+ VariableSampleRate output. See
+ https://code.soundsoftware.ac.uk/projects/vamp-plugin-sdk/wiki/SampleType
 
  ** WARNING: Plugin returned one or more NaN/inf values
 
@@ -255,6 +263,20 @@
  If you give the -n or --nondeterministic option, vamp-plugin-tester
  will downgrade this error to a note.
 
+ ** ERROR: Call to reset after setting parameters, but before processing, changes the results (parameter values not retained through reset?)
+
+ The plugin was constructed and run twice on the same data. The first
+ time, its parameters were set to some arbitrary values and it was
+ initialised and run. The second time, its parameters were set to the
+ same values and it was initialised, then reset(), then run. The two
+ runs returned different results, suggesting that perhaps some
+ parameter value was being modified within the reset() function. (This
+ function should reset internal state within the plugin, but not
+ parameter configuration.)
+
+ If you give the -n or --nondeterministic option, vamp-plugin-tester
+ will downgrade this error to a note.
+
  ** WARNING: Constructor takes some time to run: work should be deferred to initialise?
 
  The plugin took a long time to construct.  You should ensure that the