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 <anton@khirnov.net>
Signed-off-by: James Almer <jamrial@gmail.com>
This commit is contained in:
James Almer 2022-09-21 18:30:47 -03:00
parent af919cf780
commit 05cff214b9
1 changed files with 3 additions and 0 deletions

View File

@ -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;