ref: e1d9490a0a0f9afd8f0bb6251f2ba389c2419e64
parent: fd070173a35b25cec96b5a23e51839444bba94d3
author: Ulrich Klauer <ulrich@chirlu.de>
date: Fri Jan 27 12:02:26 EST 2012
Extend sox_effect_t documentation
--- a/src/sox.h
+++ b/src/sox.h
@@ -1604,13 +1604,13 @@
sox_encodinginfo_t const * out_encoding; /**< Information about the outgoing data encoding */
sox_effect_handler_t handler; /**< The handler for this effect */
sox_sample_t * obuf; /**< output buffer */
- size_t obeg; /**< output buffer consumed */
- size_t oend; /**< output buffer total length */
- size_t imin; /**< minimum input buffer size */
+ size_t obeg; /**< output buffer: start of valid data section */
+ size_t oend; /**< output buffer: one past valid data section (oend-obeg is length of current content) */
+ size_t imin; /**< minimum input buffer content required for calling this effect's flow function; set via lsx_effect_set_imin() */
sox_uint64_t clips; /**< increment if clipping occurs */
size_t flows; /**< 1 if MCHAN, number of chans otherwise */
size_t flow; /**< flow number */
- void * priv; /**< Effect's private data area */
+ void * priv; /**< Effect's private data area (each flow has a separate copy) */
};
/**