core/devformat.h

   1 #ifndef CORE_DEVFORMAT_H
   2 #define CORE_DEVFORMAT_H
   3
   4 #include <cstdint>
   5 #include <cstddef>
   6
   7
   8 using uint = unsigned int;
   9
  10 enum Channel : unsigned char {
  11     FrontLeft = 0,
  12     FrontRight,
  13     FrontCenter,
  14     LFE,
  15     BackLeft,
  16     BackRight,
  17     BackCenter,
  18     SideLeft,
  19     SideRight,
  20
  21     TopCenter,
  22     TopFrontLeft,
  23     TopFrontCenter,
  24     TopFrontRight,
  25     TopBackLeft,
  26     TopBackCenter,
  27     TopBackRight,
  28
  29     BottomFrontLeft,
  30     BottomFrontRight,
  31     BottomBackLeft,
  32     BottomBackRight,
  33
  34     Aux0,
  35     Aux1,
  36     Aux2,
  37     Aux3,
  38     Aux4,
  39     Aux5,
  40     Aux6,
  41     Aux7,
  42     Aux8,
  43     Aux9,
  44     Aux10,
  45     Aux11,
  46     Aux12,
  47     Aux13,
  48     Aux14,
  49     Aux15,
  50
  51     MaxChannels
  52 };
  53
  54
  55 /* Device formats */
  56 enum DevFmtType : unsigned char {
  57     DevFmtByte,
  58     DevFmtUByte,
  59     DevFmtShort,
  60     DevFmtUShort,
  61     DevFmtInt,
  62     DevFmtUInt,
  63     DevFmtFloat,
  64
  65     DevFmtTypeDefault = DevFmtFloat
  66 };
  67 enum DevFmtChannels : unsigned char {
  68     DevFmtMono,
  69     DevFmtStereo,
  70     DevFmtQuad,
  71     DevFmtX51,
  72     DevFmtX61,
  73     DevFmtX71,
  74     DevFmtX714,
  75     DevFmtX7144,
  76     DevFmtX3D71,
  77     DevFmtAmbi3D,
  78
  79     DevFmtChannelsDefault = DevFmtStereo
  80 };
  81 inline constexpr std::size_t MaxOutputChannels{16};
  82
  83 /* DevFmtType traits, providing the type, etc given a DevFmtType. */
  84 template<DevFmtType T>
  85 struct DevFmtTypeTraits { };
  86
  87 template<>
  88 struct DevFmtTypeTraits<DevFmtByte> { using Type = int8_t; };
  89 template<>
  90 struct DevFmtTypeTraits<DevFmtUByte> { using Type = uint8_t; };
  91 template<>
  92 struct DevFmtTypeTraits<DevFmtShort> { using Type = int16_t; };
  93 template<>
  94 struct DevFmtTypeTraits<DevFmtUShort> { using Type = uint16_t; };
  95 template<>
  96 struct DevFmtTypeTraits<DevFmtInt> { using Type = int32_t; };
  97 template<>
  98 struct DevFmtTypeTraits<DevFmtUInt> { using Type = uint32_t; };
  99 template<>
 100 struct DevFmtTypeTraits<DevFmtFloat> { using Type = float; };
 101
 102 template<DevFmtType T>
 103 using DevFmtType_t = typename DevFmtTypeTraits<T>::Type;
 104
 105
 106 uint BytesFromDevFmt(DevFmtType type) noexcept;
 107 uint ChannelsFromDevFmt(DevFmtChannels chans, uint ambiorder) noexcept;
 108 inline uint FrameSizeFromDevFmt(DevFmtChannels chans, DevFmtType type, uint ambiorder) noexcept
 109 { return ChannelsFromDevFmt(chans, ambiorder) * BytesFromDevFmt(type); }
 110
 111 const char *DevFmtTypeString(DevFmtType type) noexcept;
 112 const char *DevFmtChannelsString(DevFmtChannels chans) noexcept;
 113
 114 enum class DevAmbiLayout : bool {
 115     FuMa,
 116     ACN,
 117
 118     Default = ACN
 119 };
 120
 121 enum class DevAmbiScaling : unsigned char {
 122     FuMa,
 123     SN3D,
 124     N3D,
 125
 126     Default = SN3D
 127 };
 128
 129 #endif /* CORE_DEVFORMAT_H */