RepoMirrors
/
ffmpeg
mirror of https://git.ffmpeg.org/ffmpeg.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

avutil/channel_layout: move and improve the comment about unknown orders 

Don't place it as doxy specific for the order field, and generalize it both to
also cover already defined orders and to not make it seem like the user is
required to handle a layout they don't fully support or understand.

Signed-off-by: James Almer <jamrial@gmail.com>
This commit is contained in:
James Almer 2022-09-25 20:00:46 -03:00
parent bcd2e7d685
commit 299253ae1b
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
libavutil/channel_layout.h
View File

@ -266,6 +266,9 @@ typedef struct AVChannelCustom {
* A channel layout here is defined as a set of channels ordered in a specific * A channel layout here is defined as a set of channels ordered in a specific
* way (unless the channel order is AV_CHANNEL_ORDER_UNSPEC, in which case an * way (unless the channel order is AV_CHANNEL_ORDER_UNSPEC, in which case an
* AVChannelLayout carries only the channel count). * AVChannelLayout carries only the channel count).
* All orders may be treated as if they were AV_CHANNEL_ORDER_UNSPEC by
* ignoring everything but the channel count, as long as av_channel_layout_check()
* considers they are valid.
* *
* Unlike most structures in Libav, sizeof(AVChannelLayout) is a part of the * Unlike most structures in Libav, sizeof(AVChannelLayout) is a part of the
* public ABI and may be used by the caller. E.g. it may be allocated on stack * public ABI and may be used by the caller. E.g. it may be allocated on stack
@ -290,9 +293,6 @@ typedef struct AVChannelCustom {
typedef struct AVChannelLayout { typedef struct AVChannelLayout {
/** /**
* Channel order used in this layout. * 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. * This is a mandatory field.
*/ */
enum AVChannelOrder order; enum AVChannelOrder order;