lavr: clarify documentation for avresample_get/set_matrix()
authorJustin Ruggles <justin.ruggles@gmail.com>
Thu, 29 Nov 2012 19:59:19 +0000 (14:59 -0500)
committerJustin Ruggles <justin.ruggles@gmail.com>
Tue, 11 Dec 2012 19:00:32 +0000 (14:00 -0500)
libavresample/avresample.h

index affeeeb..a73d686 100644 (file)
@@ -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()