core/buffer_storage.h

   1 #ifndef CORE_BUFFER_STORAGE_H
   2 #define CORE_BUFFER_STORAGE_H
   3
   4 #include <atomic>
   5
   6 #include "albyte.h"
   7 #include "alnumeric.h"
   8 #include "ambidefs.h"
   9
  10
  11 using uint = unsigned int;
  12
  13 /* Storable formats */
  14 enum FmtType : unsigned char {
  15     FmtUByte,
  16     FmtShort,
  17     FmtFloat,
  18     FmtDouble,
  19     FmtMulaw,
  20     FmtAlaw,
  21 };
  22 enum FmtChannels : unsigned char {
  23     FmtMono,
  24     FmtStereo,
  25     FmtRear,
  26     FmtQuad,
  27     FmtX51, /* (WFX order) */
  28     FmtX61, /* (WFX order) */
  29     FmtX71, /* (WFX order) */
  30     FmtBFormat2D,
  31     FmtBFormat3D,
  32     FmtUHJ2, /* 2-channel UHJ, aka "BHJ", stereo-compatible */
  33     FmtUHJ3, /* 3-channel UHJ, aka "THJ" */
  34     FmtUHJ4, /* 4-channel UHJ, aka "PHJ" */
  35     FmtSuperStereo, /* Stereo processed with Super Stereo. */
  36 };
  37
  38 enum class AmbiLayout : unsigned char {
  39     FuMa,
  40     ACN,
  41 };
  42 enum class AmbiScaling : unsigned char {
  43     FuMa,
  44     SN3D,
  45     N3D,
  46     UHJ,
  47 };
  48
  49 uint BytesFromFmt(FmtType type) noexcept;
  50 uint ChannelsFromFmt(FmtChannels chans, uint ambiorder) noexcept;
  51 inline uint FrameSizeFromFmt(FmtChannels chans, FmtType type, uint ambiorder) noexcept
  52 { return ChannelsFromFmt(chans, ambiorder) * BytesFromFmt(type); }
  53
  54 constexpr bool IsBFormat(FmtChannels chans) noexcept
  55 { return chans == FmtBFormat2D || chans == FmtBFormat3D; }
  56
  57 /* Super Stereo is considered part of the UHJ family here, since it goes
  58  * through similar processing as UHJ, both result in a B-Format signal, and
  59  * needs the same consideration as BHJ (three channel result with only two
  60  * channel input).
  61  */
  62 constexpr bool IsUHJ(FmtChannels chans) noexcept
  63 { return chans == FmtUHJ2 || chans == FmtUHJ3 || chans == FmtUHJ4 || chans == FmtSuperStereo; }
  64
  65 /** Ambisonic formats are either B-Format or UHJ formats. */
  66 constexpr bool IsAmbisonic(FmtChannels chans) noexcept
  67 { return IsBFormat(chans) || IsUHJ(chans); }
  68
  69 constexpr bool Is2DAmbisonic(FmtChannels chans) noexcept
  70 {
  71     return chans == FmtBFormat2D || chans == FmtUHJ2 || chans == FmtUHJ3
  72         || chans == FmtSuperStereo;
  73 }
  74
  75
  76 using CallbackType = int(*)(void*, void*, int);
  77
  78 struct BufferStorage {
  79     CallbackType mCallback{nullptr};
  80     void *mUserData{nullptr};
  81
  82     uint mSampleRate{0u};
  83     FmtChannels mChannels{FmtMono};
  84     FmtType mType{FmtShort};
  85     uint mSampleLen{0u};
  86
  87     AmbiLayout mAmbiLayout{AmbiLayout::FuMa};
  88     AmbiScaling mAmbiScaling{AmbiScaling::FuMa};
  89     uint mAmbiOrder{0u};
  90
  91     inline uint bytesFromFmt() const noexcept { return BytesFromFmt(mType); }
  92     inline uint channelsFromFmt() const noexcept
  93     { return ChannelsFromFmt(mChannels, mAmbiOrder); }
  94     inline uint frameSizeFromFmt() const noexcept { return channelsFromFmt() * bytesFromFmt(); }
  95
  96     inline bool isBFormat() const noexcept { return IsBFormat(mChannels); }
  97 };
  98
  99 #endif /* CORE_BUFFER_STORAGE_H */