Merge remote-tracking branch 'qatar/master'

[ffmpeg] / libavutil / channel_layout.h

diff --git a/libavutil/channel_layout.h b/libavutil/channel_layout.h
index 2906098313a29e09e08e53b9a2188eab472c18e3..ba4f96d2d04dfd215d0c07a4a7feb05f589edfa5 100644 (file)
--- a/libavutil/channel_layout.h
+++ b/libavutil/channel_layout.h
@@ -136,7 +136,12 @@ enum AVMatrixEncoding {
  * - a channel layout mask, in hexadecimal starting with "0x" (see the
  *   AV_CH_* macros).
  *
- * Example: "stereo+FC" = "2+FC" = "2c+1c" = "0x7"
+ * @warning Starting from the next major bump the trailing character
+ * 'c' to specify a number of channels will be required, while a
+ * channel layout mask could also be specified as a decimal number
+ * (if and only if not followed by "c").
+ *
+ * Example: "stereo+FC" = "2c+FC" = "2c+1c" = "0x7"
  */
 uint64_t av_get_channel_layout(const char *name);