From 05cff214b9234c0e24ffe73b0bb929787267c7e2 Mon Sep 17 00:00:00 2001 From: James Almer Date: Wed, 21 Sep 2022 18:30:47 -0300 Subject: [PATCH] avutil/channel_layout: mention how the API user should treat channel orders it does not understand In case new orders are added in the future, existing library users can still use the layout simply by ignoring everything but the channel count in it, so make this explicit. Reviewed-by: Anton Khirnov Signed-off-by: James Almer --- libavutil/channel_layout.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/libavutil/channel_layout.h b/libavutil/channel_layout.h index 4dd6614de9..9e685fab72 100644 --- a/libavutil/channel_layout.h +++ b/libavutil/channel_layout.h @@ -290,6 +290,9 @@ typedef struct AVChannelCustom { typedef struct AVChannelLayout { /** * Channel order used in this layout. + * Any value not defined in the AVChannelOrder enum in a layout that + * av_channel_layout_check() doesn't reject must be treated as if it was + * AV_CHANNEL_ORDER_UNSPEC. * This is a mandatory field. */ enum AVChannelOrder order;