aboutsummaryrefslogtreecommitdiffstats
path: root/libavresample/avresample.h
diff options
context:
space:
mode:
authorMichael Niedermayer <michaelni@gmx.at>2012-12-12 10:31:49 +0100
committerMichael Niedermayer <michaelni@gmx.at>2012-12-12 10:31:56 +0100
commit82c0211213430a9aef0d6ef5b29de35043f5bcba (patch)
treec6b102b3756f9be53f28f6a0e078ed9d12861ac0 /libavresample/avresample.h
parent8dbc384f1527446b07eb6a673101f765e67f3eca (diff)
parent14758e3211d34a97c42b07acae117ce5627d7f57 (diff)
downloadffmpeg-82c0211213430a9aef0d6ef5b29de35043f5bcba.tar.gz
Merge commit '14758e3211d34a97c42b07acae117ce5627d7f57'
* commit '14758e3211d34a97c42b07acae117ce5627d7f57': lavr: temporarily store custom matrix in AVAudioResampleContext lavr: clarify documentation for avresample_get/set_matrix() Merged-by: Michael Niedermayer <michaelni@gmx.at>
Diffstat (limited to 'libavresample/avresample.h')
-rw-r--r--libavresample/avresample.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/libavresample/avresample.h b/libavresample/avresample.h
index affeeeb73b..a73d6865ac 100644
--- a/libavresample/avresample.h
+++ b/libavresample/avresample.h
@@ -216,6 +216,9 @@ int avresample_build_matrix(uint64_t in_layout, uint64_t out_layout,
/**
* Get the current channel mixing matrix.
*
+ * If no custom matrix has been previously set or the AVAudioResampleContext is
+ * not open, an error is returned.
+ *
* @param avr audio resample context
* @param matrix mixing coefficients; matrix[i + stride * o] is the weight of
* input channel i in output channel o.
@@ -231,7 +234,8 @@ int avresample_get_matrix(AVAudioResampleContext *avr, double *matrix,
* Allows for setting a custom mixing matrix, overriding the default matrix
* generated internally during avresample_open(). This function can be called
* anytime on an allocated context, either before or after calling
- * avresample_open(). avresample_convert() always uses the current matrix.
+ * avresample_open(), as long as the channel layouts have been set.
+ * avresample_convert() always uses the current matrix.
* Calling avresample_close() on the context will clear the current matrix.
*
* @see avresample_close()