diff --git a/modules/juce_audio_basics/buffers/juce_AudioChannelSet.h b/modules/juce_audio_basics/buffers/juce_AudioChannelSet.h index 4a23d6c5b6..bded8f9c07 100644 --- a/modules/juce_audio_basics/buffers/juce_AudioChannelSet.h +++ b/modules/juce_audio_basics/buffers/juce_AudioChannelSet.h @@ -272,95 +272,95 @@ public: /** Represents different audio channel types. */ enum ChannelType { - unknown = 0, + unknown = 0, /**< Unknown channel type. */ //============================================================================== - left = 1, // L - right = 2, // R - centre = 3, // C (sometimes M for mono) + left = 1, /**< L channel. */ + right = 2, /**< R channel. */ + centre = 3, /**< C channel. (Sometimes M for mono) */ //============================================================================== - LFE = 4, - leftSurround = 5, // Ls - rightSurround = 6, // Rs - leftCentre = 7, // Lc (AAX/VST), Lc used as Lss in AU for most layouts - rightCentre = 8, // Rc (AAX/VST), Rc used as Rss in AU for most layouts - centreSurround = 9, // Cs/S - surround = centreSurround, // Cs/S - leftSurroundSide = 10, // Lss (AXX), Side Left "Sl" (VST), Left Centre "LC" (AU) - rightSurroundSide = 11, // Rss (AXX), Side right "Sr" (VST), Right Centre "Rc" (AU) - topMiddle = 12, - topFrontLeft = 13, - topFrontCentre = 14, - topFrontRight = 15, - topRearLeft = 16, - topRearCentre = 17, - topRearRight = 18, - LFE2 = 19, - leftSurroundRear = 20, // Lsr (AAX), Lcs (VST), Rls (AU) - rightSurroundRear = 21, // Rsr (AAX), Rcs (VST), Rrs (AU) - wideLeft = 22, - wideRight = 23, + LFE = 4, /**< LFE channel. */ + leftSurround = 5, /**< Ls channel. */ + rightSurround = 6, /**< Rs channel. */ + leftCentre = 7, /**< Lc (AAX/VST), Lc used as Lss in AU for most layouts. */ + rightCentre = 8, /**< Rc (AAX/VST), Rc used as Rss in AU for most layouts. */ + centreSurround = 9, /**< Cs/S channel. */ + surround = centreSurround, /**< Same as Centre Surround channel. */ + leftSurroundSide = 10, /**< Lss (AXX), Side Left "Sl" (VST), Left Centre "LC" (AU) channel. */ + rightSurroundSide = 11, /**< Rss (AXX), Side right "Sr" (VST), Right Centre "Rc" (AU) channel. */ + topMiddle = 12, /**< Top Middle channel. */ + topFrontLeft = 13, /**< Top Front Left channel. */ + topFrontCentre = 14, /**< Top Front Centre channel. */ + topFrontRight = 15, /**< Top Front Right channel. */ + topRearLeft = 16, /**< Top Rear Left channel. */ + topRearCentre = 17, /**< Top Rear Centre channel. */ + topRearRight = 18, /**< Top Rear Right channel. */ + LFE2 = 19, /**< Second LFE channel. */ + leftSurroundRear = 20, /**< Lsr (AAX), Lcs (VST), Rls (AU) channel. */ + rightSurroundRear = 21, /**< Rsr (AAX), Rcs (VST), Rrs (AU) channel. */ + wideLeft = 22, /**< Wide Left channel. */ + wideRight = 23, /**< Wide Right channel. */ //============================================================================== // Used by Dolby Atmos 7.0.2 and 7.1.2 - topSideLeft = 28, // Lts (AAX), Tsl (VST) - topSideRight = 29, // Rts (AAX), Tsr (VST) + topSideLeft = 28, /**< Lts (AAX), Tsl (VST) channel for Dolby Atmos. */ + topSideRight = 29, /**< Rts (AAX), Tsr (VST) channel for Dolby Atmos. */ //============================================================================== // Ambisonic ACN formats - all channels are SN3D normalised // zero-th and first-order ambisonic ACN - ambisonicACN0 = 24, - ambisonicACN1 = 25, - ambisonicACN2 = 26, - ambisonicACN3 = 27, + ambisonicACN0 = 24, /**< Zero-th ambisonic channel number 0. */ + ambisonicACN1 = 25, /**< First-order ambisonic channel number 1. */ + ambisonicACN2 = 26, /**< First-order ambisonic channel number 2. */ + ambisonicACN3 = 27, /**< First-order ambisonic channel number 3. */ // second-order ambisonic - ambisonicACN4 = 30, - ambisonicACN5 = 31, - ambisonicACN6 = 32, - ambisonicACN7 = 33, - ambisonicACN8 = 34, + ambisonicACN4 = 30, /**< Second-order ambisonic channel number 4. */ + ambisonicACN5 = 31, /**< Second-order ambisonic channel number 5. */ + ambisonicACN6 = 32, /**< Second-order ambisonic channel number 6. */ + ambisonicACN7 = 33, /**< Second-order ambisonic channel number 7. */ + ambisonicACN8 = 34, /**< Second-order ambisonic channel number 8. */ // third-order ambisonic - ambisonicACN9 = 35, - ambisonicACN10 = 36, - ambisonicACN11 = 37, - ambisonicACN12 = 38, - ambisonicACN13 = 39, - ambisonicACN14 = 40, - ambisonicACN15 = 41, + ambisonicACN9 = 35, /**< Third-order ambisonic channel number 9. */ + ambisonicACN10 = 36, /**< Third-order ambisonic channel number 10. */ + ambisonicACN11 = 37, /**< Third-order ambisonic channel number 11. */ + ambisonicACN12 = 38, /**< Third-order ambisonic channel number 12. */ + ambisonicACN13 = 39, /**< Third-order ambisonic channel number 13. */ + ambisonicACN14 = 40, /**< Third-order ambisonic channel number 14. */ + ambisonicACN15 = 41, /**< Third-order ambisonic channel number 15. */ // fourth-order ambisonic - ambisonicACN16 = 42, - ambisonicACN17 = 43, - ambisonicACN18 = 44, - ambisonicACN19 = 45, - ambisonicACN20 = 46, - ambisonicACN21 = 47, - ambisonicACN22 = 48, - ambisonicACN23 = 49, - ambisonicACN24 = 50, + ambisonicACN16 = 42, /**< Fourth-order ambisonic channel number 16. */ + ambisonicACN17 = 43, /**< Fourth-order ambisonic channel number 17. */ + ambisonicACN18 = 44, /**< Fourth-order ambisonic channel number 18. */ + ambisonicACN19 = 45, /**< Fourth-order ambisonic channel number 19. */ + ambisonicACN20 = 46, /**< Fourth-order ambisonic channel number 20. */ + ambisonicACN21 = 47, /**< Fourth-order ambisonic channel number 21. */ + ambisonicACN22 = 48, /**< Fourth-order ambisonic channel number 22. */ + ambisonicACN23 = 49, /**< Fourth-order ambisonic channel number 23. */ + ambisonicACN24 = 50, /**< Fourth-order ambisonic channel number 24. */ // fifth-order ambisonic - ambisonicACN25 = 51, - ambisonicACN26 = 52, - ambisonicACN27 = 53, - ambisonicACN28 = 54, - ambisonicACN29 = 55, - ambisonicACN30 = 56, - ambisonicACN31 = 57, - ambisonicACN32 = 58, - ambisonicACN33 = 59, - ambisonicACN34 = 60, - ambisonicACN35 = 61, + ambisonicACN25 = 51, /**< Fifth-order ambisonic channel number 25. */ + ambisonicACN26 = 52, /**< Fifth-order ambisonic channel number 26. */ + ambisonicACN27 = 53, /**< Fifth-order ambisonic channel number 27. */ + ambisonicACN28 = 54, /**< Fifth-order ambisonic channel number 28. */ + ambisonicACN29 = 55, /**< Fifth-order ambisonic channel number 29. */ + ambisonicACN30 = 56, /**< Fifth-order ambisonic channel number 30. */ + ambisonicACN31 = 57, /**< Fifth-order ambisonic channel number 31. */ + ambisonicACN32 = 58, /**< Fifth-order ambisonic channel number 32. */ + ambisonicACN33 = 59, /**< Fifth-order ambisonic channel number 33. */ + ambisonicACN34 = 60, /**< Fifth-order ambisonic channel number 34. */ + ambisonicACN35 = 61, /**< Fifth-order ambisonic channel number 35. */ //============================================================================== - ambisonicW = ambisonicACN0, - ambisonicX = ambisonicACN3, - ambisonicY = ambisonicACN1, - ambisonicZ = ambisonicACN2, + ambisonicW = ambisonicACN0, /**< Same as zero-th ambisonic channel number 0. */ + ambisonicX = ambisonicACN3, /**< Same as first-order ambisonic channel number 3. */ + ambisonicY = ambisonicACN1, /**< Same as first-order ambisonic channel number 1. */ + ambisonicZ = ambisonicACN2, /**< Same as first-order ambisonic channel number 2. */ //============================================================================== discreteChannel0 = 64 /**< Non-typed individual channels are indexed upwards from this value. */