[FFmpeg-devel] [PATCH] avutil/channel_layout: mention how the API user should treat channel orders it does not understand

* [FFmpeg-devel] [PATCH] avutil/channel_layout: mention how the API user should treat channel orders it does not understand
@ 2022-09-21 21:42 James Almer
  2022-09-22 12:52 ` Anton Khirnov
  0 siblings, 1 reply; 2+ messages in thread
From: James Almer @ 2022-09-21 21:42 UTC (permalink / raw)
  To: ffmpeg-devel

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.

Signed-off-by: James Almer <jamrial@gmail.com>
---
 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;
-- 
2.37.3

_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".

^ permalink raw reply	[flat|nested] 2+ messages in thread