[xiph-commits] r12622 - trunk/speex/include/speex

[jm at svn.xiph.org]

Author: jm
Date: 2007-03-03 20:30:51 -0800 (Sat, 03 Mar 2007)
New Revision: 12622

Modified:
   trunk/speex/include/speex/speex.h
Log:
document the fact that the encoder input is used as scratch.


Modified: trunk/speex/include/speex/speex.h
===================================================================
--- trunk/speex/include/speex/speex.h	2007-03-03 20:20:40 UTC (rev 12621)
+++ trunk/speex/include/speex/speex.h	2007-03-04 04:30:51 UTC (rev 12622)
@@ -322,7 +322,9 @@
 /** Uses an existing encoder state to encode one frame of speech pointed to by
     "in". The encoded bit-stream is saved in "bits".
  @param state Encoder state
- @param in Frame that will be encoded with a +-2^15 range
+ @param in Frame that will be encoded with a +-2^15 range. This data MAY be 
+        overwritten by the encoder and should be considered uninitialised 
+        after the call.
  @param bits Bit-stream where the data will be written
  @return 0 if frame needs not be transmitted (DTX only), 1 otherwise
  */