summaryrefslogtreecommitdiff
path: root/libavresample/avresample.h
diff options
context:
space:
mode:
authorJustin Ruggles <justin.ruggles@gmail.com>2012-11-29 20:58:05 -0500
committerJustin Ruggles <justin.ruggles@gmail.com>2012-12-16 19:26:17 -0500
commitf1c2915ce1ea36782e0aebd108cd48db53b03c8b (patch)
tree2f731aabde61773143ca83c12872b4b7482451af /libavresample/avresample.h
parentf322b2073581119de5da74f92a03309a36891cfa (diff)
lavr: remove automatic context close/open for resampling compensation
It adds unnecessary complication for insignificant usability improvement. The user really should know if they'll need resampling compensation before opening the context. Note that only the documentation has changed. The current functionality will still work until the next major bump.
Diffstat (limited to 'libavresample/avresample.h')
-rw-r--r--libavresample/avresample.h9
1 files changed, 4 insertions, 5 deletions
diff --git a/libavresample/avresample.h b/libavresample/avresample.h
index a73d6865ac..4841d262c0 100644
--- a/libavresample/avresample.h
+++ b/libavresample/avresample.h
@@ -252,11 +252,10 @@ int avresample_set_matrix(AVAudioResampleContext *avr, const double *matrix,
/**
* Set compensation for resampling.
*
- * This can be called anytime after avresample_open(). If resampling was not
- * being done previously, the AVAudioResampleContext is closed and reopened
- * with resampling enabled. In this case, any samples remaining in the output
- * FIFO and the current channel mixing matrix will be restored after reopening
- * the context.
+ * This can be called anytime after avresample_open(). If resampling is not
+ * automatically enabled because of a sample rate conversion, the
+ * "force_resampling" option must have been set to 1 when opening the context
+ * in order to use resampling compensation.
*
* @param avr audio resample context
* @param sample_delta compensation delta, in samples