clarify ebur128_true_peak API

jiixyj · Nov 25, 2013 · 532e96e · 532e96e
1 parent c6c5425
commit 532e96e
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/ebur128/ebur128.h b/ebur128/ebur128.h
@@ -260,9 +260,13 @@ int ebur128_sample_peak(ebur128_state* st,
 
 /** \brief Get maximum true peak of selected channel in float format.
  *
- *  Uses the Speex resampler with quality level 8 to calculate true peak. Will
- *  oversample 4x for sample rates < 96000 Hz, 2x for sample rates < 192000 Hz
- *  and leave the signal unchanged for 192000 Hz.
+ *  Uses an implementation defined algorithm to calculate the true peak. Do not
+ *  try to compare resulting values across different versions of the library,
+ *  as the algorithm may change.
+ *
+ *  The current implementation uses the Speex resampler with quality level 8 to
+ *  calculate true peak. Will oversample 4x for sample rates < 96000 Hz, 2x for
+ *  sample rates < 192000 Hz and leave the signal unchanged for 192000 Hz.
  *
  *  @param st library state
  *  @param channel_number channel to analyse