[FFmpeg-cvslog] avutil/channel_layout: fix remains of old syntax in docs and comments
Marton Balint
git at videolan.org
Wed Jan 25 00:55:56 EET 2017
ffmpeg | branch: master | Marton Balint <cus at passwd.hu> | Mon Dec 26 01:06:22 2016 +0100| [5049f05f27c20f0606209bf3508e1157e0eabc9e] | committer: Marton Balint
avutil/channel_layout: fix remains of old syntax in docs and comments
Signed-off-by: Marton Balint <cus at passwd.hu>
> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=5049f05f27c20f0606209bf3508e1157e0eabc9e
---
doc/utils.texi | 14 +++++++-------
libavutil/channel_layout.h | 7 +------
2 files changed, 8 insertions(+), 13 deletions(-)
diff --git a/doc/utils.texi b/doc/utils.texi
index 7aea460..df887c7 100644
--- a/doc/utils.texi
+++ b/doc/utils.texi
@@ -719,19 +719,19 @@ the name of a standard channel layout (e.g. @samp{mono},
the name of a single channel (e.g. @samp{FL}, @samp{FR}, @samp{FC}, @samp{LFE}, etc.)
@item
-a number of channels, in decimal, optionally followed by 'c', yielding
-the default channel layout for that number of channels (see the
-function @code{av_get_default_channel_layout})
+a number of channels, in decimal, followed by 'c', yielding the default channel
+layout for that number of channels (see the function
+ at code{av_get_default_channel_layout}). Note that not all channel counts have a
+default layout.
@item
a channel layout mask, in hexadecimal starting with "0x" (see the
@code{AV_CH_*} macros in @file{libavutil/channel_layout.h}.
@end itemize
-Starting from libavutil version 53 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").
+Before libavutil version 53 the trailing character "c" to specify a number of
+channels was optional, but now it is required, while a channel layout mask can
+also be specified as a decimal number (if and only if not followed by "c").
See also the function @code{av_get_channel_layout} defined in
@file{libavutil/channel_layout.h}.
diff --git a/libavutil/channel_layout.h b/libavutil/channel_layout.h
index ec7effe..38c3337 100644
--- a/libavutil/channel_layout.h
+++ b/libavutil/channel_layout.h
@@ -131,17 +131,12 @@ enum AVMatrixEncoding {
* 5.0(side), 5.1, 5.1(side), 7.1, 7.1(wide), downmix);
* - the name of a single channel (FL, FR, FC, LFE, BL, BR, FLC, FRC, BC,
* SL, SR, TC, TFL, TFC, TFR, TBL, TBC, TBR, DL, DR);
- * - a number of channels, in decimal, optionally followed by 'c', yielding
+ * - a number of channels, in decimal, followed by 'c', yielding
* the default channel layout for that number of channels (@see
* av_get_default_channel_layout);
* - a channel layout mask, in hexadecimal starting with "0x" (see the
* AV_CH_* macros).
*
- * @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);
More information about the ffmpeg-cvslog
mailing list