changeset 4375:b095d631bec4

Added a short explanation for the freq_data argument in VisPlugin.
author Matti Hamalainen <ccr@tnsp.org>
date Fri, 28 Mar 2008 02:19:37 +0200
parents 20c70e3a8272
children b3888565029e
files src/audacious/plugin.h
diffstat 1 files changed, 7 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/src/audacious/plugin.h	Tue Mar 25 21:26:45 2008 +0200
+++ b/src/audacious/plugin.h	Fri Mar 28 02:19:37 2008 +0200
@@ -1187,6 +1187,13 @@
     void (*playback_start) (void);
     void (*playback_stop) (void);
     void (*render_pcm) (gint16 pcm_data[2][512]);
+    
+    /* The range of intensities is 0 - 32767 (though theoretically it is
+     * possible for the FFT to result in bigger values, making the final
+     * intensity negative due to overflowing the 16bit signed integer.)
+     *
+     * If output is mono, only freq_data[0] is filled.
+     */
     void (*render_freq) (gint16 freq_data[2][256]);
 };