[xiph-commits] r17949 - trunk/theora/include/theora

[tterribe at svn.xiph.org]

Author: tterribe
Date: 2011-05-02 18:48:58 -0700 (Mon, 02 May 2011)
New Revision: 17949

Modified:
   trunk/theora/include/theora/theoraenc.h
Log:
Update documentation for TH_ENCCTL_SET_BITRATE.

Make a note that passing 0 for the bitrate may not be guaranteed to
 return an error in future versions.


Modified: trunk/theora/include/theora/theoraenc.h
===================================================================
--- trunk/theora/include/theora/theoraenc.h	2011-05-02 00:38:09 UTC (rev 17948)
+++ trunk/theora/include/theora/theoraenc.h	2011-05-03 01:48:58 UTC (rev 17949)
@@ -330,7 +330,11 @@
  * \retval 0             Success.
  * \retval TH_EFAULT     \a _enc or \a _buf is <tt>NULL</tt>.
  * \retval TH_EINVAL     The target bitrate was not positive.
- * \retval TH_EIMPL       Not supported by this implementation.*/
+ *                       A future version of this library may allow passing 0
+ *                        to disabled rate-controlled mode and return to a
+ *                        quality-based mode, in which case this function will
+ *                        not return an error for that value.
+ * \retval TH_EIMPL      Not supported by this implementation.*/
 #define TH_ENCCTL_SET_BITRATE (30)
 /**Sets the configuration to be compatible with that from the given setup
  *  header.