[xiph-commits] r9131 - experimental/derf/theora-exp/include/theora

[tterribe at motherfish-iii.xiph.org]

Author: tterribe
Date: 2005-04-13 16:17:59 -0700 (Wed, 13 Apr 2005)
New Revision: 9131

Modified:
   experimental/derf/theora-exp/include/theora/theora.h
Log:
Explicitly state that the striped decode callback is called from
 theora_decode_packetin().


Modified: experimental/derf/theora-exp/include/theora/theora.h
===================================================================
--- experimental/derf/theora-exp/include/theora/theora.h	2005-04-11 15:13:35 UTC (rev 9130)
+++ experimental/derf/theora-exp/include/theora/theora.h	2005-04-13 23:17:59 UTC (rev 9131)
@@ -201,7 +201,7 @@
 #define OC_DECCTL_SET_GRANPOS (5)
 /**Sets the striped decode callback function.
  * If set, this function will be called as each piece of a frame is fully
- *  decoded.
+ *  decoded in theora_decode_packetin().
  * You can pass in a #theora_stripe_callback with
  *  theora_stripe_callback#stripe_decoded set to <tt>NULL</tt> to disable the
  *  callbacks at any point.
@@ -254,7 +254,8 @@
 
 /**A callback function for striped decode.
  * This is a function pointer to an application-provided function that will be
- *  called each time a section of the image is fully decoded.
+ *  called each time a section of the image is fully decoded in
+ *  theora_decode_packetin().
  * This allows the application to process the section immediately, while it is
  *  still in cache.
  * Note that the frame is decoded bottom to top, so \a _yfrag0 will steadily
@@ -781,6 +782,8 @@
 extern int theora_decode_packetin(theora_dec_ctx *_dec,const ogg_packet *_op,
  ogg_int64_t *_granpos);
 /**Outputs the next available frame of decoded Y'CbCr data.
+ * If a striped decode callback has been set with #OC_DECCTL_STRIPE_CB, then
+ *  the application does not need to call this function.
  * \param _dec   A #theora_dec_ctx handle.
  * \param _ycbcr A video buffer structure to fill in.
  *               <tt>libtheora</tt> will fill in all the members of this