Skip to content

Commit

Permalink
[Documentation] Document the ordering of channels in output files.
Browse files Browse the repository at this point in the history
  - This CL just documents the existing behavior; the debugging wav files produced by the encoder have a fixed channel ordering based on the output layout.
  - Using mixed conventions:
    - IAMF defers to ITU-2051-3 for certain layouts and has special names for other layouts.
    - ITU-2051-3 does not define all the layouts IAMF needs.
    - The table prefers ITU-2051-3 convention labels when they are defined.

PiperOrigin-RevId: 660921379
  • Loading branch information
jwcullen committed Aug 12, 2024
1 parent ef700f2 commit 221d60c
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions iamf/cli/testdata/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,28 @@ Title | Summary
`stereo_8_samples_48khz_s16le.wav` | Tiny test file. The first channel encodes 1, 2, ... 8. The second channel encodes 65535, 65534, ... 65528. | 2 | 48kHz | pcm_s16le | 8 samples
`stereo_8_samples_48khz_s24le.wav` | Tiny test file. The first channel encodes 1, 2, ... 8. The second channel encodes 16777216, 16777215, ... 16777209. | 2 | 48kHz | pcm_s24le | 8 samples
`Transport_TOA_5s.wav` | Short clip of vehicles driving by using third-order ambisonics. | 16 | 48kHz | pcm_s16le | 5s

# Output WAV files

Output wav files are based on the
[layout](https://aomediacodec.github.io/iamf/#syntax-layout) in the mix
presentation. Typically the ordering of channels is based on the related
[ITU-2051-3](https://www.itu.int/rec/R-REC-BS.2051) layout.

Mix Presentation Layout | Channel Order Convention | Channel Order
----------------------- | ------------------------ | -------------
Sound System A (0+2+0) | ITU-2051-3 | L, R
Sound System B (0+5+0) | ITU-2051-3 | L, R, C, LFE, Ls, Rs
Sound System C (2+5+0) | ITU-2051-3 | L, R, C, LFE, Ls, Rs, Ltf, Rtf
Sound System D (4+5+0) | ITU-2051-3 | L, R, C, LFE, Ls, Rs, Ltf, Rtf, Ltr, Rtr
Sound System E (4+5+1) | ITU-2051-3 | L, R, C, LFE, Ls, Rs, Ltf, Rtf, Ltr, Rtr, Cbf
Sound System F (3+7+0) | ITU-2051-3 | C, L, R, LH, RH, LS, LB, RB, CH, LFE1, LFE2
Sound System G (4+9+0) | ITU-2051-3 | L, R, C, LFE, Lss, Rss, Lrs, Rrs, Ltf, Rtf, Ltb, Rtb, Lsc, Rsc
Sound System H (9+10+3) | ITU-2051-3 | FL, FR, FC, LFE1, BL, BR, FLc, FRc, BC, LFE2, SiL, SiR, TpFL, TpFR, TpFC, TpC, TpBL, TpBR, TpSiL, TpSiR, TpBC, BtFC, BtFL, BtFR
Sound System I (0+7+0) | ITU_2051-3 | L, R, C, LFE, Lss, Rss, Lrs, Rrs
Sound System J (4+7+0) | ITU_2051-3 | L, R, C, LFE, Lss, Rss, Lrs, Rrs, Ltf, Rtf, Ltb, Rtb
Sound System 10 | IAMF | L7, R7, C, LFE, Lss7, Rss7, Lrs7, Rrs7, Ltf2, Rtf2
Sound System 11 | IAMF | L3, R3, C, LFE, Ltf3, Rtf3,
Sound System 12 | IAMF | C
Sound System 13 | IAMF | FL, FR, FC, LFE, BL, BR, FLc, FRc, SiL, SiR, TpFL, TpFR, TpBL, TpBR, TpSiL, TpSiR
Binaural Layout | IAMF | L2, R2

0 comments on commit 221d60c

Please sign in to comment.